SrijanShovit / carbonops-v2

https://carbonops-v2.vercel.app
MIT License
19 stars 46 forks source link

Carbonops : Environmental Awareness Project

A 💻 web application for creating personalized accountancy towards our🌲environment among 🤝‍🧑 people.


GitHub code size in bytes GitHub last commit GitHub stars My stars GitHub forks Languages Top Issues Watchers

Problems Addressed:

Features:

The site will have two portals:

1) Individual Users

2) Eco-friendly startups

Objectives:

Wanna know how the flow of all records is being planned in the app?🤔 Do have a look below

Database ER diagram:

Database ER diagram

Click here to checkout the ER diagram.

Target audience:

All

Project constraints:

Languages and Tools:

git mongodb nextjs nodejs postman nextauthjs Tailwind CSS

Youtube Demo of version 1

Repo Link v1

We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. Please note we have a Code of Conduct, please follow it in all your interactions with the project.

Setting up the project:

This documentation contains set of guidelines to help you during the contribution process. Contributing Guidelines

  1. Fork this repoistory using Github GUI.

  2. Clone the project in your PC

  3. Change the directory to project's directory.

cd ./Carbonops-v2
  1. Install the dependencies
npm install
  1. Set up a .env file

    • Add relevant credentials in the .env file with the help of .env.example file.
  2. Start the development server

npm run dev
  1. Open http://localhost:3000 with your browser to see the app up and running 🎉🥳🎊.

Documentation:

Having issues in understanding the codebase?

Then head over to documentation, give yourself some time and please comeback to contribute.

Checkout the Next.js documentation here

Checkout the Oauth documentation here

If you 💓 the project, do smash the ⭐ button!!

Thanks for visiting!!

Thank You