lordksix's F1mania App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [lordksix's F1mania App]

lordksix's F1mania App is a web application where the user can check all information about Formula 1. Current Standing, Next events, previous results and historic data. Completely responsive with screen size and detects if user is using dark more. This app is written using Tailswind, NextJS, ReactJS and Typescript.

(back to top)

🛠 Built With

Tech Stack

Client

• HTML5
• CSS
• Typescript

Framework

• React
• NextJS
• TailwindCSS

Database

• MongoDB

Key Features

• NextJS App
• Productions deployed
• Add Youtube plugin
• Add Twitter plugin
• Add Google, Facebook and GitHub login
• Implement MongoDB
• Implement SignUp
• Fetch Formula 1 data from API

🚀 Live Demo

You can find a live demo in HERE.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. To run local server or to make any modifications to the project NPM and Node.js must be installed.

Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

Setup

Clone this repository to your desired folder:

For example, using Ubuntu:

  cd my-desired-folder
  git clone https://github.com/lordksix/f1-next-app.git

For more information on how to clone or fork a repository:

• How to clone a repo
• How to fork a repo

If you want to make any kind of change or modification, Node.Js and NPM is necesary. For more information on how to install node.js and npm:

• Downloading and installing Node.js and npm

Install

To install dependencies, the following command must be run in the terminal:

  cd f1-next-app
  npm install

Usage

In the project directory, you can run:

  npm npm run dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.\

This will check Linter error and quick fix when possible to fix.

  npm run build

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 ready to be deployed!

Run tests

Launches the test runner in the interactive watch mode.

  npm test

Deployment

This project is deployed using Vercel.

Go to 🚀 Live Demo to check it out.

(back to top)

👥 Authors

👤 Author

• GitHub: @lordksix
• LinkedIn: @wladpasquel
• Medium: @wladimir.pasquel

(back to top)

🔭 Future Features

Future changes:

• Add webcraler to add specfic information.
• Improve styling.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.

(back to top)

🙏 Acknowledgments

.

(back to top)

❓ FAQ

• Do I need a IDE or a special text editor to make changes?

  • No, you don't. You can use NotePad to make changes.

(back to top)

📝 License

This project is MIT licensed.

(back to top)