https://github.com/forrestknight/dev-trivia
https://github.com/forrestknight/dev-trivia
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/forrestknight/dev-trivia
- Owner: ForrestKnight
- License: mit
- Created: 2024-10-17T20:26:11.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-13T16:06:47.000Z (over 1 year ago)
- Last Synced: 2025-03-26T03:51:12.413Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://thehackershideout.com
- Size: 165 KB
- Stars: 35
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dev Trivia
This project is a live, weekly developer trivia application built with Vite, React, Tailwind CSS, TypeScript, and Convex.
## Prerequisites
Before you begin, ensure you have the following installed:
- [Node.js](https://nodejs.org/) (version 14 or later recommended)
- [npm](https://www.npmjs.com/) (usually comes with Node.js)
- [Git](https://git-scm.com/)
## Getting Started
Follow these steps to set up and run the project locally:
1. Clone the repository:
```
git clone https://github.com/forrestknight/dev-trivia.git
cd dev-trivia
```
2. Install dependencies:
```
npm install
```
3. Set up Convex:
- If you haven't already, create a Convex account at [https://dashboard.convex.dev](https://dashboard.convex.dev)
- Run the following command and follow the prompts to create a Convex project:
```
npx convex dev
```
4. Set up Clerk (for authentication):
- Follow the [Convex + Clerk](https://docs.convex.dev/auth/clerk) documentation.
- Copy the Clerk publishable key and add it to your `.env.local` file:
```
VITE_CLERK_PUBLISHABLE_KEY=your_publishable_key_here
```
5. Start the development server:
```
npm run dev
```
This command will start both the frontend and backend servers concurrently.
## Project Structure
- `/src`: Contains the React frontend code
- `/convex`: Contains the Convex backend code
- `/public`: Contains public assets
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is open source and available under the [MIT License](LICENSE).