Giter VIP home page Giter VIP logo

ecoleta's Introduction

Ecoleta Logo

♻️ Ecoleta - is a way to connect companies and entities that collect organic and inorganic waste to people who need to dispose of their waste in an ecological way.
Developed at NLW#1
Practical project for study

Ecoleta is released under the MIT license Ecoleta is currently maintained by Silvio Ronaldo This is the number of forks in this repository This is the number of stars in this repository Badges are awesome


📋 Table of contents


📌 Status

🚧 Ecoleta is in development... 🚀


🖥️ Demonstration

Web Layout

Ecoleta Layout


Web Usage

Ecoleta Usage


Mobile

Ecoleta Mobile Screen 1 Ecoleta Mobile Screen 2


🕹️ Running locally

Prerequisites

  1. Installing Git: You need to have Git on your machine to perform a few steps. To download Git, click here.

  2. Installing Node: To run the server you will need Node.js, to download it, click here.

  3. Installing Expo: To run the mobile, you need to install the Expo, click here.

  4. Installing Yarn 1: Yarn is a package manager that you can download directly from the website by clicking here. If you prefer, use the NPM.

  5. Code Editor (optional): Make sure you have a code editor of your choice. I recommend using the VS Code. If you need to, download it here.

🎲 Running the backend server

  1. In a terminal, clone this repository:

    git clone https://github.com/Silvio-Ronaldo/Ecoleta.git

  2. Enter the project folder:

    cd Ecoleta

  3. Enter the server folder:

    cd server

  4. Install all dependencies:

    yarn install or yarn

  5. Start the database with Knex migrations:

    yarn knex:migrate

    yarn knex:seed

  6. Start the development server:

    yarn dev

  7. After these steps, the server should start at the 3333 port.

⚛️ Running the React app

  1. If you have already cloned the repository, proceed, otherwise, see step 1 in 'running the backend server'
  2. Enter the project folder:

    cd Ecoleta

  3. Enter the web folder:

    cd web

  4. Install all dependencies:

    yarn install or yarn

  5. Start the web development server:

    yarn start

  6. After these steps, the server should start at the 3000 port, open the browser and access http://localhost:3000.

📱 Running the Mobile app

  1. With the Expo installed, according to the documentation, follow
  2. Enter the project folder:

    cd Ecoleta

  3. Enter the mobile folder:

    cd mobile

  4. Install all dependencies:

    yarn install or yarn

  5. Start the mobile development server:

    yarn start

  6. After these steps, the mobile application must start on your emulator or on your device, according to your choice.

🛡️ Technologies

The following tools were used in the development of the project:

Backend


Web


Mobile


👽 Author

Silvio Ronaldo
Silvio Ronaldo

🍀

Leave your star, fork the project or open a pull request ❤️

Contact me on social networks:

Silvio Ronaldo's Twitter Silvio Ronaldo's LinkedIn


⚖️ License

Ecoleta is MIT licensed, as found in the LICENSE file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.