2019-07-14 11:47:06 +00:00
|
|
|
# fediverse.space backend
|
|
|
|
|
|
|
|
|
|
## Notes
|
|
|
|
|
|
|
|
|
|
- This project requires Elixir >= 1.9.
|
|
|
|
|
- Run with `SKIP_CRAWL=true` to just run the server (useful for working on the API without also crawling)
|
2019-07-17 16:16:25 +00:00
|
|
|
- This project is automatically scanned for potential vulnerabilities with [Sobelow](https://sobelow.io/).
|
2019-07-14 11:47:06 +00:00
|
|
|
|
|
|
|
|
## Deployment
|
|
|
|
|
|
|
|
|
|
Deployment with Docker is handled as per the [Distillery docs](https://hexdocs.pm/distillery/guides/working_with_docker.html).
|
|
|
|
|
|
|
|
|
|
- To build a new version, run `make build` in this directory.
|
|
|
|
|
- To migrate a released version, run `./backend eval "Backend.Release.migrate"`
|
|
|
|
|
|
|
|
|
|
# Default README
|
|
|
|
|
|
|
|
|
|
To start your Phoenix server:
|
|
|
|
|
|
|
|
|
|
- Install dependencies with `mix deps.get`
|
|
|
|
|
- Create and migrate your database with `mix ecto.setup`
|
|
|
|
|
- Start Phoenix endpoint with `mix phx.server`
|
|
|
|
|
|
|
|
|
|
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
|
|
|
|
|
|
|
|
|
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
|
|
|
|
|
|
|
|
|
|
## Learn more
|
|
|
|
|
|
|
|
|
|
- Official website: http://www.phoenixframework.org/
|
|
|
|
|
- Guides: https://hexdocs.pm/phoenix/overview.html
|
|
|
|
|
- Docs: https://hexdocs.pm/phoenix
|
|
|
|
|
- Mailing list: http://groups.google.com/group/phoenix-talk
|
|
|
|
|
- Source: https://github.com/phoenixframework/phoenix
|
