gabrielmaialva33 / soc-ex-api

Soc Ex is a social experiment that uses the Phoenix framework to create an API.

A Social Network in Phoenix

About   |    Technologies   |    Installation   |    Configuration   |    Documentation   |    License

🔖 About

Soc Ex is a social experiment that uses the Phoenix framework to create an API.

💻 Technologies

• Elixir
• Phoenix
• Docker
• PostgreSQL

📦 Installation

# clone the repository
git clone https://github.com/gabrielmaialva33/soc-ex-api.git
# enter the directory
cd soc-ex-api
# install the dependencies
mix deps.get # or mix deps.get --only prod
# edit `config/dev.exs` and configure your database or use the environment variables
nano config/dev.exs # or vim config/dev.exs
# run the database migrations
mix ecto.setup # or mix ecto.setup --only prod
# start the server
mix phx.server # or mix phx.server --only prod

🔧 Configuration

open the config/dev.exs file and configure your database

# Configure your database
config :soc_ex_api, SocExApi.Repo,
  username: "postgres",
  password: "postgres",
  database: "soc_ex_api_dev",
  hostname: "localhost",
  show_sensitive_data_on_connection_error: true,
  pool_size: 10

📝 Documentation

# Use insomnia or postman to test the routes

file `soc-ex-api.yaml` in root directory

✍️ Author

Maia

License

MIT License