/Jssconnect

A website using node js for providing study resources to students.

Primary LanguageEJS

Visit our website here

JSSCONNECT

Issues Pull Requests Forks Stars  

One Destination for meeting all your educational needs that is related to college study.

Jss Connect is an e-platform for helping engineering students in their academics.

Jssconnect Introduction

Features

Jss Connect is an e-platform for helping engineering students in their academics. Engineering students can

  • Get books, notes and previous year papers.
  • Read and write Blogs that will help you and others too.
  • With our Built in Blog Previewer you can customize and design your blog in a way that seems more appealing and interesting.
  • Resources like books and notes(pdfs) sharing made easier. So you can help us in providing Resources that are helpful to engineering students.
  • Connect with peers within our community (with the security of google authentication) with the help of Chat-application(Jss Wire) integrated with JSS Connect.
  • Tech-Stacks:

    Our Team




    Our Contributors !! ✨

    Thanks to these wonderful people: ✨

    You can contribute by following below set of instructions

    Environment Setup-
    • Drop a ⭐ on the GitHub repository.




    • Robo 3T is a desktop graphical user interface (GUI) for Mongo DB. It can help to skip running all the Mongo DB commands manually every time we want to access the data. Download Robo 3T (optional)

    • Fork the repository and then clone it from forked copy.

    • Clone the repository by running command

    git clone https://github.com/ <your user-name> /jssconnect.git
    

    in your git bash.

    • Run command cd jssconnect.

    • Run this command to install all dependencies for the project.
    npm install
    

    All the current dependencies -

        "body-parser": "^1.19.0",
        "dotenv": "^8.2.0",
        "ejs": "^3.1.5",
        "express": "^4.17.1",
        "express-session": "^1.17.1",
        "mongoose": "^5.10.3",
        "mongoose-findorcreate": "^3.0.0",
        "nodemailer": "^6.4.11",
        "passport": "^0.4.1",
        "passport-google-oauth20": "^2.0.0",
        "passport-local-mongoose": "^6.0.1",
        "url": "^0.11.0"
    

    • Run this command on your terminal/ bash to start the Mongo server on port 27017(default).
    mongod
    

    • Run this command to start the project on local host 3000.
    npm start
    

    • Open link to view the website in your browser window if it doesn't open automatically.
    http://localhost:3000/
    

    • You can learn more about EJS template engine and its syntax to know how we can use it inside our HTML using the documentation

    • Now you are all set to use this project.

    Some useful Mongo DB commands if you are using the terminal instead of the GUI-

    show dbs
    use db <db name>
    show collections
    <db name> .find()
    

    Note

    • Get connection string from Mongo Atlas by creating a cluster or you can also use your locally installed mongodb.
    • You can click here to learn how to connect atlas to you project.
    • Create a new file named .env in the Backend folder and copy the format of .env.example file
    • Paste the connection string in the .env file in the MONGODB_URI variable.
    • Get your client_id and client_secret by creating a new app in google developer console.And enter client_id in CLIENT_ID variable and client_secret in CLIENT_SECRET variable.

    No need for google sign in in production mode.