- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
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.
Client
Framework
Database
- 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
You can find a live demo in HERE.
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.
In order to run this project you need: To clone or fork and run it in a browser
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:
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:
To install dependencies, the following command must be run in the terminal:
cd f1-next-app
npm install
In the project directory, you can run:
npm npm run dev
Runs the app in the development mode.
Open https://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!
Launches the test runner in the interactive watch mode.
npm test
This project is deployed using Vercel.
Go to 🚀 Live Demo to check it out.
👤 Author
- GitHub: @lordksix
- LinkedIn: @wladpasquel
- Medium: @wladimir.pasquel
Future changes:
- Add webcraler to add specfic information.
- Improve styling.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
.
-
Do I need a IDE or a special text editor to make changes?
- No, you don't. You can use NotePad to make changes.
This project is MIT licensed.