Skip to content

ribeiromatheus/ecoplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub language count Repository size GitHub last commit Packagist

The ecological marketplace

🛠️ Technologies

📂 Libs/Modules

🚪 Server

  • express - for server creation.
  • cors - to allow the API to be accessible to the web application.
  • Knex.js - SQL query builder for Javascript.

🌐 Web

📱 Mobile

💻 About the application

Ecoplace is a web and mobile app to register and search for a waste collection point, such as light bulbs, organic and electronic waste, paper, cardboard and cooking oil.

🚪 Server

The server is an API Restful; you must run it to use the web and mobile app.

🌐 Web app

The web app is for registering a waste collection point.

🏠 Home Page

Here is the Home Page; click the button to register your waste collection point.

image

📋 Registration Page

Here is the Registration Page; fill in the fields to get your waste collection point registered and ready to be found.

📱 Mobile app

The mobile app is where you can find the waste collection point. You can contact the owner's waste collection point via email and whatsapp for more details.

🏠 Home

Here is the Home Screen; fill in the fields with your state and city to check out the available waste collection point near you.

📭 Points

Here is the Points Screen; select the kind of residue you would like so you can see the available waste collection point near you.

📃 Detail

Here is the Detail Screen; here you can see more about the waste collection point and send a whatsapp message or email it.

🚀 Get started

⚠️ Requirements

🧭 Cloning, installing and some configs

  1. At first, clone the repo by running git clone https://github.com/ribeiromatheus/ecoplace.git or hub clone ribeiromatheus/ecoplace - if you have hub installed on your machine - on your favorite terminal.
  2. After cloning run yarn or npm install on server, web and mobile folder.
  3. After that, go to server folder and rename .env.example file to .env, then enter your own credentials.
  4. Still in the server folder, run yarn knex:migrate or npm run knex:migrate to generate the database and yarn knex:seed or npm run knex:seed to create insert the "items" into the items table.
  5. Next, go to mobile/src folder and create a folder named credentials, then create a json file named baseUrl so you can add your ip address followed by server port or your server url only.
{
    "ip": "http://<ip goes here>:<port goes here>"
}

🎲 Running the server (API)

# run with yarn
cd ecoplace/server
yarn dev

# run with npm
npm run dev

🎲 Running the Web app

# run with yarn
cd ecoplace/web
yarn start

# run with npm
npm run start

🎲 Running the Mobile app

# run with yarn
cd ecoplace/mobile
yarn start

# run with npm
npm run start

📝 License

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