Verified Commit 67e9f93a authored by Haelwenn's avatar Haelwenn
Browse files

README.md: Do some documentation

parent fbe79d9d
Pipeline #2223 failed with stages
in 13 seconds
# Mastodon Glitch Edition / mastofe repository
Here is a fork of mastodon. We could really just remove all of the code except
for the frontend, but to easily pull the upstream repo we'll just keep
everything. This is my fork for the moment with the idea of making the mastofe
just as polished as the pleromafe. If you want to get access, open an issue or
hit me up at howl@social.zxq.co.
Here is a fork of mastodon. We could really just remove all of the code except for the frontend, but to easily pull the upstream repo we'll just keep everything. This is my fork for the moment with the idea of making the mastofe just as polished as the pleromafe. If you want to get access, open an issue or hit me up at lanodan@social.hacktivis.me.
# Development
......@@ -12,18 +8,10 @@ I use a combination of the pleroma backend + yarn + nginx to do local
development. I refuse to install Ruby. Here's how to get it running on your own
machine:
## Install yarn
Yarn will be needed to set up the mastodon frontend for development. Check out
https://yarnpkg.com/lang/en/docs/install/ . For Debian, it's like this:
```sh
# import yarn pub key and repo
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update
sudo apt-get install yarn
```
## Dependencies
* yarn
* Node.JS with npm
* nginx (for testing it in your browser)
## Mastodon Frontend Setup
......@@ -44,7 +32,7 @@ config.
```
server {
listen 80;
server_name pleroma.testing;
server_name localhost;
location /packs {
add_header 'Access-Control-Allow-Origin' '*';
......@@ -66,9 +54,14 @@ server {
}
```
Change the `server_name` if you like. I personally like to create a new entry
in /etc/hosts and add `127.0.0.1 pleroma.testing`, but you do what suits you.
# Updating from upstream
- Add the upstream, if you didn’t already: ``git remote add glitch-soc https://github.com/glitch-soc/mastodon.git``
- Fetch upstream (pulling only master from them is fine too): ``git fetch glitch-soc``
- Rebase on them (tip: use ``git rebase -i`` if you need to change some commits): ``git rebase glitch-soc/master``
- Force(because of rebase) push to your glitchsoc-fe, remember to set your current branch to potentially avoid erasing other branches: ``git push -f origin mastofe/glitch-soc``
If you have enough luck, navigating to your \<server\_name\>/web should show
you the mastodon frontend, and should also work with all the nice things of
webpack such as hot reloading. Have fun!
## Why rebase instead of merge
- We should just have a set of patches on top of glitch-soc to make it work (maybe a bit of branding) and tend to upstream other changes
- Merging can lead to loosing some of our patches (happened to mastofe, the previous repo)
- It allows us to see more easily what are our changes compared to upstream
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment