README.md

English · Portuguese

About   |    Technologies   |    Tools   |    Installation   |    License

🔖 About

The Ecoleta aims to bring together people looking for collection points for non-recyclable materials such as lamps, batteries, oil, etc, with institutions that accept to receive these materials. The backend consists of a Rest API running on a NodeJS server. The frontend was made with React and the mobile app with React Native. This project was implemented during the Next Level Week #1 of Rocketseat.

💻 Technologies

• Typescript
• Node.js
• Express
• Knex
• SQLite
• ReactJS
• React Native
• Celebrate
• Expo
• Axios

🔧 Tools

• VisualStudio Code
• Insomnia
• Google Chrome
• DBeaver

📦 Installation

✔️ Prerequisites

The following software must be installed:

• Node.js
• Git
• NPM or Yarn
• Expo
• Expo App

⬇️ Cloning the repository

  $ git clone https://github.com/maiquelp/Ecoleta.git

▶️ Running the applications

• 📦 API

  $ cd server
  # Dependencies install.
  $ yarn # or npm install
  # Data base creation.
  $ yarn knex:migrate # or npm run knex:migrate
  # API start
  $ yarn start # or npm start

• 💻 Web app

  $ cd web
  # Dependencies install.
  $ yarn # or npm install
  # Running web app
  $ yarn start # or npm start

• 📱 Mobile app

  $ cd mobile
  # Dependencies install.
  $ yarn # or npm install
  # Running mobile app
  $ yarn start # or npm start

📝 License

This project is under the MIT license.