Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 1.37 KB

README.md

File metadata and controls

48 lines (28 loc) · 1.37 KB

Aim-Ace

A website that creates and tracks personalized study plans for students, with features like flashcard creation and progress tracking and notify based on it.

View This Project On

https://devfolio.co/projects/aimace-b46f

Prerequisites

Before you begin, make sure you have the following installed on your machine:

Installation

  1. Clone the repository to your local machine using the following command: git clone (https://github.com/sankettank66/Aim-Ace.git)

  2. Navigate to the project directory:cd project

  3. Install the dependencies:npm install

  4. Set up the database:Start your local MongoDB server.

  5. Configuration:

  • Rename the .env.example file to .env.
  • Modify the .env file and update the required environment variables with your own configuration.

Usage

  1. Start the development server:

npm start

  1. Open your web browser and visit http://localhost:3000 to access the application.

Contributing

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature-name.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push the branch to your forked repository: git push origin feature/your-feature-name.
  5. Submit a pull request.