DashGo

A cool dashboard prototype built with Next.js and Chakra UI
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

An MVP of an application with dashboard and users.

Features:

• Login
• Access dashboards
• Check the users´ list
• Create a new user

Built With

• Apex Charts
• Axios
• Chakra UI
• Emotion
• Framer Motion
• Mirage JS
• Next JS
• React Hooks Form
• React Icons
• React JS
• React Query
• TypeScript
• Yup

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/dashgo.git

2. Install packages

   yarn | npm install

3. Run the following commands in root folder start the application in a development environment:

   yarn dev | npm run dev

Usage

Login Pages - Desktop and Mobile views

Dashboard Pages - Desktop and Mobile views

Users Pages - Desktop and Mobile views

Create a User Pages - Desktop and Mobile views

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Acknowledgements

• ESLint
• Prettier