Codymate

level up your code presentations

Codymate is a code presentation tool that lets you create interactive code scenes with step-by-step typing animations, transforming your code into engaging slides.

Table of Contents

• Development Setup
  • Setting up Frontend
  • Setting up Backend
• Contributing
• Ideas for Improvement
• License

Development Setup

To clone and run this project, you'll need Git and Node.js (which comes with npm) installed on your computer.

1. Clone frontend repo

git clone https://github.com/brrkrmn/codymate.git

Setting up Frontend

1. Cd into the repo

cd codymate/frontend

2. Install dependencies

npm install

3. Run the app

npm run dev

Setting up Backend

1. Go into the repo

cd codymate/backend

2. Install dependencies

npm install

5. Run the server

npm run dev

Contributing

Codymate is an open-source project, and your help is always welcome! I encourage you to go through the Contribution Guidelines and check out the Ideas for Improvement section to contribute Codymate.

Ideas for Improvement

• Adding a search bar to language selection
• Adding default presets for background selection
• Add a light mode option
• Show a confirmation prompt before deleting
• Implement auto-save in editor to prevent losing changes
• Make the "Untitled" input more editable
• Handle unnecessary scrollbars throughout the project for different browsers
• Add a prompt to prevent accidental page exits
• Theme selection should show a visible scrollbar to imply there are more options
• Improve the colors of the save, preview, delete and warning buttons on editor page
• Add an option to automatically play the slides, without requiring button clicks
• Allow users to select the speed of the typing animation
• Clarify project goal better on landing page – Improve the explanation of what CodyMate does and how it benefits developers.

License

Licensed under the MIT License.