Tech With Tim website frontend

---

Frontend for the Tech with Tim website using React.

📝 Table of Contents

• Getting Started
• Deployment
• Built Using
• Contributing
• License
• Authors

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Install the required packages with Node Package Manager:

npm install

Running

Run the app in the development mode:

npm start

Open http://localhost:3000 to view the website in the browser.

The page will reload if you make edits. And you will also see any lint errors in the console.

🔧 Running the tests

Run tests with:

npm test

⚠ You need to write tests when contributing ⚠

Api Setup

• cd api
• touch .env write the .env file based on this template

  SECRET_KEY='longsecret key'
  DB_URI=postgresql://user:password@db:5432/twt
  POSTGRES_USER=user
  POSTGRES_PASSWORD=password
  POSTGRES_DB=twt
  DISCORD_CLIENT_ID=<discord client id : int>
  DISCORD_CLIENT_SECRET=<discord client secret :string>

• docker-compose up This may fail the first time but try again

🚀 Deployment

Start by building the app with:

npm run build

This builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

Your app is now ready to be deployed!

⛏️ Built Using

• React - Frontend framework

✍️ Authors

• @mohamed040406 - Everything
• @takos22 - Markdown files

See also the list of contributors who participated in this project.