Visit our website here

Chitter

Mini social media app(like twitter) that lets the user signup, login, and then post anything on their mind.

Tech-Stack:

You may setup by following below set of instructions

Environment Setup-

• Drop a ⭐ on the GitHub repository.

• Download and install a code/ text editor.
  • Recommended-
    • Download VS Code
    • Download Atom

• Download Node Js and npm(Node package manager) (when you download Node, npm also gets installed by default)

• Mongo DB community edition is free & a great software in order to work with MongoDB applications. Download Mongo DB community editition

• 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> /Chitter.git

in your git bash.

• Run command cd Chitter.

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

npm install

All the current dependencies -

    "bcrypt": "^5.0.0",
    "body-parser": "^1.19.0",
    "cloudinary": "^1.26.0",
    "dotenv": "^10.0.0",
    "ejs": "^3.1.5",
    "express": "^4.17.1",
    "express-session": "^1.17.1",
    "mongoose": "^5.9.24",
    "mongoose-findorcreate": "^3.0.0",
    "nodemailer": "^6.4.10",
    "passport": "^0.4.1",
    "passport-facebook": "^3.0.0",
    "passport-google-oauth20": "^2.0.0",
    "passport-local-mongoose": "^6.0.1",
    "path": "^0.12.7",
    "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/

• 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.