Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.28 KB

README.md

File metadata and controls

74 lines (48 loc) · 2.28 KB

Project Name: BrainWave

Overview

BrainWave is a learning application that empowers you to build and expand you personal knowledge base while leveraging the power of spaced repetition algorithms.

Core Features

  • Personalized Learning: BrainWave is more than just a learning app; it's your personal knowledge database tailored to your individual needs and curiosity.
  • Evidence-based Learning Techniques: Our app uses the Spaced Repetition Algorithm, a scientifically proven method to improve information retention and facilitate lifelong learning.
  • Optimal Learning: BrainWave is designed to enhance your learning efficiency, helping you to remember more in less time.
  • Ease of Use: The clean and intuitive user interface makes creating and managing your knowledge database an enjoyable process.

Whether you're a student, a professional, or simply someone with an insatiable appetite for knowledge, BrainWave is the perfect learning companion to help you explore, remember, and understand the world around you.

Getting Started

Prerequisites

To get started, you need to have Node.js and npm installed on your machine. If not, you can download and install them from here.

Installation

  1. Clone the repository

    git clone https://github.com/SaschaMet/Brain-Wave.git
    
  2. Navigate into the project directory

    cd BrainWave
    
  3. Install dependencies

    npm install
    
  4. Run the development server

    npm run dev
    

After running the above command, open your browser and visit http://localhost:3000. You should now see the BrainWave application running.

Testing

To run tests, use the following command:

npm run test

Building for Production

To create a production build of the app, run the following command:

npm run build

After building, the start script can be used to start a production server:

npm run start

Contribution

Feel free to make a fork of this repository, create a branch, and make changes as you'd like. Pull requests are warmly welcome. If you encounter any bugs or have features to suggest, please open an issue.

License

This project is licensed under the MIT License. For more details, see the LICENSE file.