Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/olaishola05/coral

Coral is a frontend dashboard for managing tasks, issues, processes, and more. It is built with React, TypeScript Material UI, and some backend services.
https://github.com/olaishola05/coral

dashboard fomik material-ui mockend react reqres-api typescript

Last synced: 18 days ago
JSON representation

Coral is a frontend dashboard for managing tasks, issues, processes, and more. It is built with React, TypeScript Material UI, and some backend services.

Awesome Lists containing this project

README

        

# Coral Process Management Dashboard

## Description

Coral is a frontend dashboard for managing tasks, issues, processes, and more. It is built with React, TypeScript Material UI, and some backend services.

## This project is bootstrapped with React create app

[![better commits is enabled](https://img.shields.io/badge/better--commits-enabled?style=for-the-badge&logo=git&color=a6e3a1&logoColor=D9E0EE&labelColor=302D41)](https://github.com/Everduin94/better-commits)
![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![React](https://img.shields.io/badge/-React-black?style=for-the-badge&logo=react&logoColor=white)
![React Router](https://img.shields.io/badge/-React%20Router-black?style=for-the-badge&logo=react-router&logoColor=white)
![Eslint](https://img.shields.io/badge/-eslint-brightgreen?style=for-the-badge&logo=eslint&logoColor=white)
![Vercel](https://img.shields.io/badge/-vercel-black?style=for-the-badge&logo=vercel&logoColor=white)
![Material UI](https://img.shields.io/badge/-Material%20UI-0081CB?style=for-the-badge&logo=material-ui&logoColor=white)
![Git](https://img.shields.io/badge/-Git-black?style=for-the-badge&logo=git&logoColor=white)
![Editor](https://img.shields.io/badge/-VSCode-blue?style=for-the-badge&logo=visual-studio-code&logoColor=white)

## Demo

[Live Demo](coming soon)

![dashboard](src/Assets/images/coral-dashboard.png)

![Login](src/Assets/images/Login.png)

## Built With

- **ReactJS** - JavaScript Frontend Library
- **TypeScript** - Static Typing
- **Material UI** - UI Library
- **Reqres API** - For autentication
- **Mockend API** - For Mocking backend data & API endpoints
- **React Router** - For routing
- **Formik & Yup** - For form validation

## Getting Started

### Prerequisites

- [Node.js](https://nodejs.org/en/) - Node.jsยฎ is a JavaScript runtime built on Chrome's V8 JavaScript engine.
- [npm](https://www.npmjs.com/) - npm is the package manager for JavaScript and the worldโ€™s largest software registry.

### Installing

1. Clone the repo

```bash
git clone https://github.com/olaishola05/coral.git
```

2. Install dependencies

```bash
npm install
```

env file

```bash
REACT_APP_BASE_URL= https://reqres.in/api
```

4. Run the development server

```bash
npm start
```

5. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Author

- GitHub: [@olaishola05](https://github.com/@olaishola05)
- Twitter: [@olaishola05](https://twitter.com/@olaishola05)
- LinkedIn: [Oladipupo Ishola](https://www.linkedin.com/in/ola-ishola/)
- Medium: [@olaishola](https://medium.com/@olaishola)

## ๐Ÿค Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](https://github.com/olaishola05/coral/issues) here ๐Ÿ˜๐Ÿ˜.

### Show your support

- Give a โญ if you like this project

## Acknowledgments

- Thanks to everyone building tools to make developers lives easier
- Also to people at Lasting Dynamics for the figma design and tutoring

## License

This project is licensed under the MIT License - see the [LICENSE.md](MIT.md) file for details