Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ndikumanaisaie/admin-dashboard-backend


https://github.com/ndikumanaisaie/admin-dashboard-backend

Last synced: 12 days ago
JSON representation

Awesome Lists containing this project

README

        

logo

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Website Mockup 📱 💻 🖥️](#screenshots)
- [🖺 Entity Relationship Diagram](#er-diagram)
- [ Kanban Board](#kanban-board)
- [ React Frontend](#react-frontend)
- [ API Documentation](#api-docs)
- [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

## School Management System

> It is a system that helps school manage its activities.
## 🛠 Built With

### Tech Stack

Client

### Key Features

- **[My projects]**
- **[Technologies]**
- **[About me]**
- **[Personal Achievements]**

(back to top)

## 🚀 Live Demo

- [Ndikumana Isaie](https://ndikumanaisaie.netlify.app/)

(back to top)

## 💻 Getting Started

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

To run this project you need:
`vscode` and `node`

### Install
```
npx create-react-app
```
### Usage || Clone

To run the project, execute the following command:

```
git clone https://github.com/ndikumanaisaie/portfolio.git
```

```
npm install
```

```sh
npm start ## then go to localhost:8080
```

Run tests
```
npm test

# if you see any snapshots already created in __tests__ folder,
#kindly DELETE the snapshot folder before running test, ELSE run npm test

```

(back to top)

## 👥 Authors

👤 **Ndikumana Isaie**

- GitHub: [ndikumanaisaie](https://github.com/ndikumanaisaie)
- Twitter: [Ndikuma38670724](https://twitter.com/Ndikuma38670724)
- LinkedIn: [Ndikumana Isaie](https://www.linkedin.com/in/ndikumanaisaie/)

(back to top)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

- Hat tip to anyone whose code was used
- Microverse staff
- Our families
- etc

(back to top)

## ❓ FAQ

- **How I can install react**

- You can follow the [official guide](https://react.dev/learn) to install react. If you have node installed, you can run `npx create-react-app` to install react.

- **How to run project?**

- After cloning the repository, run `npm i` and then run `npm start`. This will run the server on `localhost:8080`. You can change the port number if you want.

- **How I can run tests?**

- After cloning the repository, run `npm test` to run the tests.

(back to top)

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)