Keybound

Learn key bindings in a fun and easy way.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Front End Setup
   • Back End Setup
3. Contributing
4. License
5. Contact

About The Project

Keybound lets users make custom cheat sheets full of shortcuts for study and easy reference. We currently support VS Code but plan to add more resources.

Built With

• React
• Tailwind CSS
• NextJS
• TypeORM
• React Query

Getting Started

To start front-end

Front End Setup

1. Enter client directory

   cd .\client\
   

2. Install NPM packages

   npm install

3. Start local

   npm run dev

Back End Setup

1. Enter client directory

   cd .\server\
   

2. Install NPM packages

   npm install

3. Setup docker

   docker-compose up

4. Setup database

   npm run db:setup

5. Start server

   npm run dev

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

Project Link: https://github.com/chingu-voyages/v29-bears-team-05