Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gmpsankalpa/modern-timetable-app

This is a modern timetable app built with React and Material-UI.
https://github.com/gmpsankalpa/modern-timetable-app

react reactjs timetable

Last synced: 3 days ago
JSON representation

This is a modern timetable app built with React and Material-UI.

Awesome Lists containing this project

README

        

# Modern Timetable App

This is a modern timetable app built with React and Material-UI.

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Features

- Display a timetable for the days of the week.
- Add, edit, and delete events for each time slot.
- Events are saved locally using browser's localStorage.

## Installation

1. Clone the repository:
```bash
git clone https://github.com/gmpsankalpa/modern-timetable-app.git

2. Navigate into the project directory:
```bash
cd modern-timetable-app

3. Install dependencies using npm or yarn:
```bash
npm install
# or
yarn install

## Usage

1. Start the development server:
```bash
npm start
# or
yarn start

2. Open your browser and visit `http://localhost:3000` to view the app.

3. Interact with the timetable by adding, editing, or deleting events for each time slot.

## Contributing

Contributions to this project are welcome. If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add some feature'`).
5. Push to the branch (`git push origin feature/your-feature-name`).
6. Create a new Pull Request.

## License

This project is licensed under the [MIT](LICENSE) License.

---



Repo Details 🤙

![repo size](https://img.shields.io/github/repo-size/gmpsankalpa/modern-timetable-app?label=Repo%20Size&style=for-the-badge&labelColor=black&color=20bf6b)
![GitHub forks](https://img.shields.io/github/forks/gmpsankalpa/modern-timetable-app?&labelColor=black&color=0fb9b1&style=for-the-badge)
![GitHub stars](https://img.shields.io/github/stars/gmpsankalpa/modern-timetable-app?&labelColor=black&color=f7b731&style=for-the-badge)
![GitHub LastCommit](https://img.shields.io/github/last-commit/gmpsankalpa/modern-timetable-app?logo=github&labelColor=black&color=d1d8e0&style=for-the-badge)



Deploy status badge 🤖



[![Netlify Status](https://api.netlify.com/api/v1/badges/f8c54f31-10f6-42a4-80e6-342090a3c60e/deploy-status)](https://app.netlify.com/sites/gmp-modern-timetable-app/deploys)