[A brief one-sentence description of what BridgeScore does. Example: A web application for tracking and managing bridge game scores.]
Check out the live application here: https://bridgescore.vercel.app/
[Provide a more detailed description of the project. What problem does it solve? Who is the target audience? What was the motivation for creating it?]
This project is built with the following technologies:
- Next.js
- Firebase
- React
- Tailwind CSS (or specify your styling library)
To get a local copy up and running, follow these simple steps.
Make sure you have Node.js and npm installed on your machine.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/masumhasan/BridgeScore.git
- Navigate to the project directory
cd BridgeScore - Install NPM packages
npm install
- Set up your environment variables
Create a
.env.localfile in the root of the project and add your Firebase configuration keys. See.env.examplefor reference.# Firebase Config NEXT_PUBLIC_FIREBASE_API_KEY=... NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=... NEXT_PUBLIC_FIREBASE_PROJECT_ID=... NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=... NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=... NEXT_PUBLIC_FIREBASE_APP_ID=... - Run the development server
Open http://localhost:3000 with your browser to see the result.
npm run dev
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Masum Hasan - @your_twitter_handle - your.email@example.com
Project Link: https://github.com/masumhasan/BridgeScore