Não sabe falar inglês? Leia a versão em português.

Ecoleta

A REST API, web and mobile application to assist the correct disposal of recyclable items. 🌳

Built during the Next Level Week #1 by Rocketseat. 🚀

📖 Purpose

Differently from the original project (which is great for a week 😄), this repository is a playground environment which includes improved resources and tools, like:

• Package maintenance with Lerna.
• Dependency management with Yarn workspaces.
• Linters: stylelint, eslint, prettier, lintstaged.
• Git hooks with husky.
• Database integration using TypeORM.
• Tests using Jest, including test coverage.
• Continuous Integration with GitHub Actions.
• React components styling with emotion and theming with theme-ui.

✨ Additional features

• (api) Environment agnostic URLs for uploaded images.
• (web) Dark/Light themes and components.
• (web) Not found (404) page.
• (web) Success message.
• (web) Client side form validation.
• (mobile) Dropdowns to select states and cities.
• (mobile) Automatically detects the local IP address for development.

🚀 Quick Start

• Install Node and Yarn.

At the root of the repository:

• Run the commands yarn and yarn bootstrap.
• Prepare the development database by running yarn migrate.
• And run the command yarn start:{project} to start one of the aplications listed below.

💼 Projects

Name	Description	Dependency
☑ api	API	--
☑ web	Web application	api
☑ mobile	Mobile application	api