t-bello7/solostudent

Open source student management dashboard system

📗 Table of Contents

• ✨ About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• Resources
• 💻 Getting Started
  • Prerequisites
  • Local Setup
  • Run tests
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

✨ About SoloStudent

SoloStudent s an offline-first web application that facilitates the student registration and management process for institutions. Admins can easily register students, capture and confirm their details, manage their profiles, and have access to additional features enhancing data handling and decision-making.

🛠 Built With

Tech Stack

• MongoDB
• React Js
• Framer Motion
• TailWindCSS

Key Features

• Student Registration: Admins can register students, capturing details including name, location, course, and faculty.
• Student Profile Management: Admins can blacklist a student, which greys out the student’s profile. Edit feature allowing admins to update students’ information when needed.
• View and Search Student Profiles: Admins can view a list of all registered students.Enhanced search functionality allows admins to filter students by various criteria including name, ID, and course
• **Insight Reports:**Get Insight reports on total sales sold

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

Resources

• Video Tutorial

• SideBar Design

• Profile Page Design

• Integrate Realm with React Article

• Severless React App with MongoDB

• Realm Web with React

• MongoDb Realm Docs

• Realm React Code Example

• MongoDB Table Relationship

• https://timmousk.com/project/psyhelp/

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node Js : To install Node Js on Linux, use the command below:

sudo apt install Nodejs

• Yarn Package Manager : After instatallation of NodeJs you install yarn using the command below:

npm install --global yarn

Local Setup

0. Fork the repo, the clone this repository using the following command (remember to replace the github username in the url)

  git clone https://github.com/<your-github-username>/solostudent

1. Go to the project folder

cd solostudent

2. Add this to the scripts key in package.json

  "postinstall": "cp ./node_modules/realm/dist/realm-js-wasm.wasm ./node_modules/.vite/deps"

3. Install the dependency required for the project using yarn package manager

yarn install

4. Set up your .env file by duplicating the .env.sample and passing in the necessary parameters

5. To run the project, execute the following command:

  yarn dev

Run tests

To run tests, run the following command:

  yarn test

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to TopBill the issues page.

(back to top)

⭐️ Show your support

If you like this project leave a star.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

Why is my commit failing ?

The application is configured to run the eslint and prettier TopBill on the precommit stage. Read the errors properly and try to fix it

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)