Skip to main content

Getting Started with TornTicker

Follow these steps to set up and run the TornTicker web app on your local machine.

Prerequisites​

  • Node.js: Install Node.js (version 14 or later is recommended).
  • npm: Comes bundled with Node.js.
  • Git: To clone the repository.

Clone the Repository​

Clone the TornTicker repository from GitHub:

git clone https://github.com/yourusername/tornticker.git
cd tornticker

Install Dependencies​

Install the required dependencies for the project:

npm install

Run the Development Server​

Start the development server:

npm run dev

This will launch the app locally, typically available at http://localhost:3000.

Next Steps​

Explore the Code: Familiarise yourself with the project structure. The frontend is built with React using Vite, and the backend is powered by FastAPI with MongoDB integration.

Backend Setup (if applicable): If you need to run the FastAPI backend, follow the instructions in the README or the dedicated backend setup guide in the documentation.

Further Customisations: Check out the Vite documentation, React documentation, and FastAPI documentation for more information on customising and extending the project.