/StudyNotion

Primary LanguageJavaScriptApache License 2.0Apache-2.0

StudyNotion

StudyNotion project is an advanced educational technology platform developed using the MERN stack (MongoDB, Express.js, React.js, Node.js). It is designed to facilitate a seamless and interactive learning experience for students while offering instructors a platform to create, manage, and distribute educational content.

Installation

To get started with the client, clone the repository and install the dependencies:

git clone https://github.com/Manan2810/StudyNotion.git
cd studynotion-client
npm install

Scripts

Here are the scripts available in this project:

  • npm start: Starts the React application.
  • npm run build: Builds the React application for production.
  • npm run test: Runs the tests using Jest.
  • npm run eject: Ejects the app configuration (be careful with this).
  • npm run server: Navigates to the server directory and starts the server.
  • npm run dev: Runs both the client and server concurrently.

Backend Scripts:

  • npm start: Starts the server by running index.js.
  • npm run dev: Runs the server in development mode using nodemon, which watches for file changes and restarts the server automatically.

Folder Structure

  • /src: Contains the source code of the client application.
  • /public: Static files like images, fonts, etc.
  • /server: Server-side code

Dependencies

The client-side and server-side dependencies are listed in the package.json file. You can install them by running:

For client-side Dependencies:

 npm install

For server-side Dependencies:

cd server
npm install

Usage

After installation, you can start the project with:

npm run dev

this will run the client side and server side code together.