README.md

Next Level Week 1.0 🚀

Project   |    Technologies   |    How to use   |    How to contribute   |    License

💻 Project

Ecoleta is an app based on international environment week that provide way to create waste collection point or search by one.

This app was created in Next Level Week, an free event that occur during a week, with code, challenges and professional networking with an objective to take programmer to the next level.

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• TypeScript
• React
• React Native
• Expo

ℹ️ How To Use

To clone and run this application, you'll need Git, Node.js + NPM installed on your computer.

From your command line:

Install API

# Clone this repository
$ git clone https://github.com/YuiMatsunaga/NLW-01.git

# Go into the repository
$ cd NLW-01/server

# Install dependencies
$ npm install

# Run Migrates
$ npm knex:migrate

# Run Seeds
$ npm knex:seed

# Start server
$ npm dev

# running on port 3333

Install Front-end

# Clone this repository
$ git clone https://github.com/YuiMatsunaga/NLW-01.git

# Go into the repository
$ cd NLW-01/web

# Install dependencies
$ npm install

# Run
$ npm start

# running on port 3000

Install Mobile

# Clone this repository
$ git clone https://github.com/YuiMatsunaga/NLW-01.git

# Go into the repository
$ cd NLW-01/mobile

# Install dependencies
$ npm install

# Run
$ npm start

# Expo will open, just scan the qrcode on terminal or expo page

# If some problem with fonts, execute:
$ expo install expo-font @expo-google-fonts/ubuntu @expo-google-fonts/roboto

🤔 How to contribute

• Make a fork;
• Create a branck with your feature: git checkout -b my-feature;
• Commit changes: git commit -m 'feat: My new feature';
• Make a push to your branch: git push origin my-feature.

After merging your receipt request to done, you can delete a branch from yours.

📝 License

This project is under the MIT license. See the LICENSE for details.

Made with 💜 by Christyan David