Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielmaialva33/soc-ex-api
Soc Ex is a social experiment that uses the Phoenix framework to create an API.
https://github.com/gabrielmaialva33/soc-ex-api
api api-rest elixir elixir-lang openapi3 phoenix phoenix-framework
Last synced: 5 days ago
JSON representation
Soc Ex is a social experiment that uses the Phoenix framework to create an API.
- Host: GitHub
- URL: https://github.com/gabrielmaialva33/soc-ex-api
- Owner: gabrielmaialva33
- License: agpl-3.0
- Created: 2023-08-08T05:29:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-14T15:49:33.000Z (11 months ago)
- Last Synced: 2025-01-16T21:25:15.262Z (6 days ago)
- Topics: api, api-rest, elixir, elixir-lang, openapi3, phoenix, phoenix-framework
- Language: Elixir
- Homepage: https://api.alucard.fun/dev/dashboard
- Size: 343 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A Social Network in Phoenix
About |
Technologies |
Installation |
Configuration |
Documentation |
License
## :bookmark: About
**Soc Ex** is a social experiment that uses the [Phoenix](https://www.phoenixframework.org/) framework to create an API.
## :computer: Technologies
- **[Elixir](https://elixir-lang.org/)**
- **[Phoenix](https://www.phoenixframework.org/)**
- **[Docker](https://www.docker.com/)**
- **[PostgreSQL](https://www.postgresql.org/)**
## :package: Installation
```bash
# 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
```
### :wrench: **Configuration**
open the `config/dev.exs` file and configure your database
```elixir
# 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
```
### :memo: **Documentation**
```md
# Use insomnia or postman to test the routes
file `soc-ex-api.yaml` in root directory
```
### :writing_hand: **Author**
| [](https://github.com/gabrielmaialva33) |
|-----------------------------------------------------------------------------------------------------------|
| [Maia](https://github.com/gabrielmaialva33) |
## License
[MIT License](./LICENSE)