README.md

Project   |    Built with   |    How to run   |    License   |    Get in touch

💻 Project

Ecoleta is an application that aims to help people find places that collect specific types of waste, encouraging people to recycle more.

🚀 Built with

This project was developed with the following technologies:

Backend

• Node.js
• Express
• TypeORM
• Typescript
• TS-Node-Dev
• Celebrate
• Tsyringe
• uuidv4
• Cors
• ESLint
• Prettier
• VS Code

Frontend

• React
• Typescript
• Styled Components
• Context API
• React-toggle
• React-spring
• uuidv4
• Axios
• React Dropzone
• React Icons
• Leaflet
• React Leaflet
• ESLint
• Prettier
• VS Code

Mobile

• React
• React Native
• Expo
• Styled Components
• Typescript
• React Navigation
• Axios
• Expo Google Fonts
• Expo Location
• Expo Mail Composer
• React Native Appearance
• React Native Picker Select
• ESLint
• Prettier
• VS Code

ℹ️ How to run

Requirements

To run the application you will need:

• Git
• Node
• Yarn

Now clone the repository and install the dependencies.

Server

# to clone the repository
$ git clone https://github.com/willerrodrigo/nlw-01.git

# go into the server folder
$ cd nlw-01/server

# install the server dependencies
$ yarn

# run Migrates
$ yarn knex:migrate

# run Seeds
$ yarn knex:seed

# start server
$ yarn dev

# running on port 3333

Web

# in another tab of the terminal install the web dependencies and run it 
$ cd web
$ yarn
$ yarn start

Mobile

The Application was developed using Expo. It is a free and open source toolchain built around React Native to facilitate the process of running and testing applications. Click here to get start with Expo.

# install the dependencies
cd mobile
yarn

In order to run the application on your device, you need to change the ip config.

api.ts

  baseURL: 'http://192.168.0.101:3333',

replace 192.168.0.101 with your machine's ip.

Now with everything on place, run the application.

# to run the app
yarn start

Expo will open a page in your browser, scan the QRcode on the page and wait for the app to load.

📝 License

This project is under the MIT license. See the LICENSE for more information

📬 Get in touch!

   

---

Made with ☕ and ❤️ by Willer Rodrigo.