Skip to content

Commit

Permalink
Update README to the pattern
Browse files Browse the repository at this point in the history
  • Loading branch information
erickmp07 committed Oct 20, 2021
1 parent 3f079bc commit cd4e975
Showing 1 changed file with 71 additions and 13 deletions.
84 changes: 71 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,77 @@
# Inmana
# inmana

To start your Phoenix server:
API to prevent loss of restaurants supplies.

* Install dependencies with `mix deps.get`
* Create and migrate your database with `mix ecto.setup`
* Start Phoenix endpoint with `mix phx.server`
## Table of Contents

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
- [Install](#install)
- [Usage](#usage)
- [Technologies](#technologies)
- [API](#api)
- [Contributing](#contributing)
- [License](#license)

Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
## Install

## Learn more
Prerequisites:

* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix
Download and install [Elixir](https://elixir-lang.org/install.html) and [Phoenix](https://hexdocs.pm/phoenix/installation.html#content).

- First, clone the repository:
```bash
git clone https://github.com/erickmp07/inmana.git
```

- Install its dependencies:
```bash
cd inmana
mix deps.get
```

- Create and migrate the database:
```bash
mix ecto.setup
mix ecto.migrate
```

## Usage

Start Phoenix endpoint:
```bash
mix phx.server
```

The application can be accessed at [`localhost:4000`](http://localhost:4000).

## Technologies

This project was developed with the following technologies:

- [Elixir](https://elixir-lang.org/)
- [Phoenix](https://www.phoenixframework.org/)
- [Erlang](https://www.erlang.org/)
- [Credo](https://github.com/rrrene/credo/)
- [Jason](https://github.com/michalmuskala/jason)
- [PostgreSQL](https://www.postgresql.org/)

## API

The available routes are:
```bash
# POST (JSON) - Create Restaurant
http://localhost:{port}/api/restaurants
body: {
"name": "Restaurant's name",
"email": "[email protected]"
}
```

## Contributing

PRs and stars are always welcome.

To ask a question, please [contact me](mailto:[email protected]).

## License

Licensed under [MIT](LICENSE) license.

0 comments on commit cd4e975

Please sign in to comment.