-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into dp/fix-tests
- Loading branch information
Showing
12 changed files
with
139 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
[asdf-vm]: https://asdf-vm.com/ | ||
|
||
# 🚀 Getting Started | ||
|
||
These instructions will get you a copy of the project up and running on your | ||
local machine for development and testing purposes. | ||
|
||
## 📥 Prerequisites | ||
|
||
The following software is required to be installed on your system: | ||
|
||
- [Erlang 25+](https://www.erlang.org/downloads) | ||
- [Elixir 1.14+](https://elixir-lang.org/install.html) | ||
- [PostgreSQL 13+](https://www.postgresql.org/download/)(^See [this section](#-docker) for setting up with docker.) | ||
|
||
We recommend using [asdf version manager][asdf-vm] to install and manage all | ||
the programming languages' requirements. | ||
|
||
If you prefer to use docker, see the [section below](#-docker). | ||
|
||
## 🔧 Setup | ||
|
||
First, clone the repository: | ||
|
||
``` | ||
git clone [email protected]:cesium/atomic.git | ||
cd atomic | ||
``` | ||
|
||
Then, run the setup script to get all dependencies configured. Make sure the database is up and running. | ||
|
||
``` | ||
bin/setup | ||
``` | ||
|
||
Then you should change the `.env.dev` file as needed. Run this script again if | ||
needed. | ||
|
||
## 🔨 Development | ||
|
||
Start the development server and then you can visit `http://localhost:4000` | ||
from your browser. | ||
|
||
``` | ||
bin/server | ||
``` | ||
|
||
Run the tests. | ||
|
||
``` | ||
bin/test | ||
``` | ||
|
||
Lint your code. | ||
|
||
``` | ||
bin/lint | ||
``` | ||
|
||
Format your code. | ||
|
||
``` | ||
bin/format | ||
``` | ||
|
||
## 🐳 Docker | ||
|
||
For data persistence this project uses a PostgreSQL database. You should have | ||
PostgreSQL up and running. | ||
|
||
If you want to setup the required database using docker containers you can | ||
easily do it with [docker-compose](https://docs.docker.com/compose/install/). | ||
|
||
Create and start the database containers. | ||
|
||
``` | ||
cp .env.dev.sample .env.dev | ||
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml up db | ||
``` | ||
|
||
Start the previously created containers. | ||
|
||
``` | ||
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml start | ||
``` | ||
|
||
Stop the containers. | ||
|
||
``` | ||
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml stop | ||
``` | ||
|
||
Destroy the containers and volumes created. | ||
|
||
``` | ||
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml down -v | ||
``` | ||
|
||
## 🔗 References | ||
|
||
You can use these resources to learn more about the technologies this project | ||
uses. | ||
|
||
- [Getting Started with Elixir](https://elixir-lang.org/getting-started/introduction.html) | ||
- [Erlang/Elixir Syntax: A Crash Course](https://elixir-lang.org/crash-course.html) | ||
- [Elixir School Course](https://elixirschool.com/en/) | ||
- [Phoenix Guides Overview](https://hexdocs.pm/phoenix/overview.html) | ||
- [Phoenix Documentation](https://hexdocs.pm/phoenix) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters