README.md

KeyKorea

Visit the live app | Report Bug | Request Feature

📝 Table of contents

• Run Locally
• Screenshots
• Technologies
• License

🚀 Run Locally

Clone repo to your local machine

git clone [email protected]:JarrodMalkovic/typing-website.git

Run the frontend

Install client dependencies

cd client
npm install

Run the development server

yarn dev

from the ./client directory

Open http://localhost:3000 with your browser to see the result.

Run the backend

Setting environment variables

• Create an account on cloudinary.com
• Create a copy of the file .env.example within the /api directory and rename the copy to .env
• Fill out the .env file using your cloudinary credentials

Start the Django App and the Postgres Database

docker-compose up

📸 Screenshots

Dark Mode	Light Mode

💻 Technologies

This project is is created with:

• React, Next.js, Python, Django Rest Framework and PostgreSQL

⚖️ License

This project is licensed under the MIT License

---

Visit the live app | Report Bug | Request Feature