README.md

Doodle Racing

An application that allows users to draw custom racetracks and test them out for themselves! Built @ VandyHacksXI!

Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage and Demo
4. Roadmap
5. License
6. Contact

About The Project

Doodle Racing is a fun application that lets users create, save, and race on custom-designed tracks. It’s designed to allow players to draw their racetrack with a flexible drawing tool and simulate racing on these tracks.

(back to top)

Built With

(back to top)

Getting Started

Tip

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/zander-raycraft/racing-VH.git

2. Install NPM packages

   npm install

3. Navigate to the backend directory

   cd backend

4. Compile the dist

   npx tsc

5. Start the server

   node dist/server.js

6. Navigate to the project directory

   cd ..
   cd racing-VH

7. Start the development server

   npm run start

(back to top)

Usage and Demo

Draw a custom racetrack using the drawing tool, and race on it!

• Signup on the Signup/Login page
• Once authenticated, go to Draw to draw and save your own tracks!
  • Load them in!
  • Go to Race to load a downloaded track in and race with it!

(back to top)

Roadmap

• Working authentication with MongoDB
• Track drawing functionality, saving tracks as JSONs with coordinates
• Tracks can be downloaded and saved as jsons
• Saved tracks are stored in the database for the user
• Tracks can be validated and sent to the Race route
• Tracklist
  • Track loading/previews
  • Track deletion
• Tracks can be raced with a camera following the user
• Racing controls display instructions and acceleration

(back to top)

License

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

(back to top)

Contact

Zander Raycraft - [email protected]

Sean Onamade - [email protected]

Ethan Milton - [email protected]

(back to top)