samyc2002 / prevelec

A beginner friendly project which aims to reduce the domestic electricity usage. The project is currently incomplete and open for contributions.

Prevelec

This website aims to reduce the amount of electricity used by people in their daily lives by providing them a report on their usage and providing bonusses on consuming lesser energy.

Instructions for execution of the code

Software to be installed beforehand:

1. NodeJs

Steps to be performed:

1. Go to MongoDB Atlas and log in. Then, create a cluster and connect it. An url will be provided by MongoDB. Save it somewhere as we will need it shortly.
2. Create a .env file in the project directory and name it ".env". Paste the following code in it.

       DB_URL='XXXXXXXXXX'
       JWT_SECRET='secret'
   

3. Replace the XXXXXXXXXX in DB_URL with the link obtained in step 1. Now, follow the below steps to run it.

Running the application:

The website server is initiated by -
npm i
node app.js
~command on git bash.

About the website

• You are first asked to log in to your account.
• If you don't have an account, click on register and make one. Otherwise, log in with your credentials (Username is your email id).
• Once logged in, you are navigated to the dashboard. The dashboard contains a graph of the energy used by the user in the year (sampled on a monthly basis).
• The dashboard also contains a leaderboard of registered users and their energy consumption.
• Blog: The blog is for sharing posts and can be accessed through the navbar on the top. Posts may be composed using the compose link in navbar.
• Home: An introductory page that contains information about the website.
• Achievements: Lists the badges obtained by the user by fulfilling the energy conservation criterias.
• Signout: Signs a user out of the active session.

Note

The website is currently incomplete and has a lot of oppurtuinities for contribution and you may use this project to get started with open source contributions as such.

The issues listed below are provided along with their difficulty levels so you may pick them accordingly.

How to contribute

• Create an Issue and wait for being assigned to it. (I shall be assigning them about twice a day)
• Fork the repository.
• Make changes and commits on the forked repository
• Create a pull request to the master branch of the original repository
• Valid pull requests will be merged

Enhancements available to do

(difficulty mentioned out of 5 and graded relatively)

• Fixing routes based errors (3)
• Fixing the deprecation warning of body parser at app.js(3)
• Making the webpage responsive (one page per PR)
(2)
• Adding database connectivity and looking in the database for valid credentials while logging in
(5)
• Typos fixing and content enhancements
(2)
• Enhancing the home page, making it the landing page
(4)
• Enhance UI of login screen
• For any other enhancements, open the issue and I shall assign it if it is appropriate.

PS: For the issues that I have opened already, comment in the issue to let me know if you are taking it up. (like by commenting 'I would like to take this up')

For any queries, contact me at [email protected]

-------------------------------------------------------------------------------