ansh240302 / yogasana

YOGASANA

Fullstack YOGA website made with MongoDB, Express, React & Nodejs (MERN)

• Configuration and Setup
• Technologies used
  • Frontend
  • Backend
  • Database
• SRS
• UML

Configuration and Setup

In order to run this project locally, ensure that you have NodeJS and MongoDB installed on your system. Then simply fork and clone the repository or download as zip and unzip on your machine.

For cloning run

$ git clone https://github.com/abdulqadir18/Yogasana.git

• Open the project in your prefered code editor.
• Go to terminal -> New terminal (If you are using VS code)
• Split your terminal into two (run the Frontend on one terminal and the Backend on the other terminal)

In the first terminal--------->

$ cd Backend
$ npm install (to install backend-side dependencies)

Now in Backend create Config folder and create config.env file in it

$ mkdir Config
$ cd Config
$ touch config.env

• Now in this .env file Set environment variables
• Create your mongoDB connection url, which you'll use as your MONGO_URI
• Supply the following credentials

#  ---  config.env  ---

NODE_ENV = development
PORT =5000
URI =http://localhost:3000
MONGO_URI =
JWT_SECRET_KEY = 
JWT_EXPIRE = 60m
RESET_PASSWORD_EXPIRE = 3600000 

# Nodemailer

SMTP_HOST =smtp.gmail.com
SMTP_PORT =587
EMAIL_USERNAME = [email protected]
EMAIL_PASS = your_password

Now again navigate back to Backend folder and run backend

$ npm start (to start the backend)

In the second terminal---------->

$ cd Frontend
$ npm install (to install frontend-side dependencies)
$ npm run start (to start the frontend)

Technologies used

This project was created using the following technologies.

Frontend

• React js - JavaScript library that is used for building user interfaces specifically for single-page applications
• React Hooks - For managing and centralizing application state
• react-router-dom - To handle routing
• axios - For making Api calls
• Css - For User Interface
• CK-Editor - Rich Text Editor
• uuid - For random id generator
• React icons - Small library that helps you add icons to your react apps.

Backend

• Node js -A runtime environment to help build fast server applications using JS
• Express js -The server for handling and routing HTTP requests
• Mongoose - For modeling and mapping MongoDB data to JavaScript
• express-async-handler - Simple middleware for handling exceptions inside of async express routes and passing them to your express error handlers
• jsonwebtoken - For authentication
• bcryptjs - For data encryption
• Nodemailer - Send e-mails from Node.js
• dotenv - Zero Dependency module that loads environment variables
• multer - Node.js middleware for uploading files
• slugify - For encoding titles into a URL-friendly format
• cors - Provides a Connect/Express middleware

Database

• MongoDB - It provides a free cloud service to store MongoDB collections.

SRS

https://docs.google.com/document/d/1j3MC5QPfGd3hD7WEzB43qHEiCVE5O6eMNn8fKWUIOUA/edit?usp=sharing

UML

https://docs.google.com/document/d/1T1jTC10cN0w8anFZVg5z0Qov0s-r-Qk3WYpoBCXK6O8/edit?usp=sharing