♻ Ecoleta API

Ecoleta is a Web and Mobile application to help people find collection points for recycling. Build on Next Week Level, organized by Rocketseat.

🔗 Table of contents

Features
Technologies
Installation
Starting
Status codes
Contribute
License

📚 Features

Points CRUD
Items CRUD
DDD and architeture SOLID

To view the Web project, follow this Ecoleta Web.

📌 Technologies

📂 Installation

First of all, it is important that you have installed Node.js and Yarn.

So, run this command in terminal to clone the project via HTTPS:

git clone https://github.com/fernandogatto/ecoleta-api.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git@github.com:fernandogatto/ecoleta-api.git

🚀 Starting

ORM configuration is on ormconfig.json. There you can configure your database settings.

Run the following command in order in terminal:

# Configure the database schema
yarn schema:sync

# Run previous seed
yarn seed:run

# Start the server
yarn dev:server

⚙ Status codes

Status	Description
200	OK
400	BAD REQUEST
404	NOT FOUND
500	INTERNAL SERVER ERROR

👍 Contribute

Fork this repository.
Create a branch with your resource: git checkout -b my-feature
Submit changes: git commit -m "feat: My new feature"
Push your branch: git push origin my-feature

📕 License

Released in 2020. This project is under the MIT License.

Build with 💜 by Fernando Gatto.