-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
207 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,216 @@ | ||
| # BikeHub: Bike Rental Website | ||
|
|
||
| **Your Journey, Your Bike, Your Freedom.** | ||
| # Your Journey, Your Bike, Your Freedom with BikeHub | ||
|
|
||
| BikeHub is a bike rental platform for enthusiasts, commuters, and tourists. This README provides an overview of the project, including team members, technologies, API endpoints, and contribution guidelines. | ||
|  | ||
|
|
||
| ## Team | ||
| Welcome to BikeHub, your premier bike rental platform designed for enthusiasts, commuters, and tourists seeking the ultimate cycling experience. Whether you're embarking on an adventure, commuting to work, or exploring a new city, BikeHub is here to elevate your journey. | ||
|
|
||
| - **ITRI M'BARKI** (Back-end Developer) | ||
| - **El Gharbi Ayoub** (Front-end Developer) | ||
| - **Mounssif nuuX BOUHLAOUI** (DevOps Engineer) | ||
| ## About BikeHub | ||
|
|
||
| BikeHub offers a seamless and user-friendly platform that allows you to rent the perfect bike for your needs. This README serves as your guide, offering insights into our talented team, cutting-edge technologies, API endpoints, and how you can contribute to making BikeHub even better. | ||
|
|
||
| ## Discover the Essence of BikeHub | ||
|
|
||
| - **Enthusiast-Focused:** Tailored for bike enthusiasts who appreciate quality and diversity in their rides. | ||
|
|
||
| - **Commute with Ease:** Ideal for daily commuters, providing a reliable and convenient solution for urban transportation. | ||
|
|
||
| - **Tourist-Friendly:** Explore new cities on two wheels, unlocking the freedom to discover hidden gems at your own pace. | ||
|
|
||
| ## Unveiling the Project | ||
|
|
||
| Dive into the heart of BikeHub by exploring our team, the technologies powering our platform, key API endpoints, and guidelines for contributing. Your journey begins here, with BikeHub as your trusted companion. | ||
|
|
||
|
|
||
|
|
||
| ## Team and Roles | ||
| - [ITRI M'BARKI](https://www.linkedin.com/in/itri-m-barki-038704232/) (Full-Stack Developer) | ||
| - [El Gharbi Ayoub](https://www.linkedin.com/in/elgharbiayoub/) (Full-Stack Developer) | ||
| - [Mounssif nuuX BOUHLAOUI](https://www.linkedin.com/in/mounssif-bouhlaoui-25934570/) (DevOps/Full-Stack Developer) | ||
|
|
||
| ## Technologies | ||
| - **Front-end**: Reactjs / chakra-ui / axios / swiper | ||
| - **Back-end**: Nest.js / jwt / passport / swagger / nodemailer / google-oauth | ||
| - **Database**: Postgresql with Prisma | ||
| - **DevOps**: PM2 / DATADOG / 2 Servers prod and dev (Google Cloud and DigitalOcean) | ||
| - **CI/CD**: Github Actions | ||
| - **Payment**: PayPal API | ||
| - **QR Code**: QR Code Generator Library | ||
|
|
||
| ## Installation (still on going) | ||
|
|
||
| Follow these steps to set up BikeHub locally on your machine: | ||
|
|
||
| 1. **Clone the Repository:** | ||
| - Open your terminal and run: | ||
| ```bash | ||
| git clone https://github.com/your-username/BikeHub.git ~/BikeHub/ | ||
| ``` | ||
|
|
||
| 2. **Install Dependencies:** | ||
| - Navigate to the project directory: | ||
| ```bash | ||
| cd ~/BikeHub/ && npm install && yarn install | ||
| ``` | ||
|
|
||
| 3. **Build Frontend:** | ||
| - Move to the frontend directory and start the build process: | ||
| ```bash | ||
| cd ~/BikeHub/frontend && npm run build | ||
| ``` | ||
|
|
||
| 4. **Serve Frontend:** | ||
| - Use a server to serve the frontend on port 3000: | ||
| ```bash | ||
| serve -l 3000 -s ~/BikeHub/frontend/dist | ||
| ``` | ||
|
|
||
| 5. **Configure API Environment:** | ||
| - Update the API configuration by copying the example environment file: | ||
| ```bash | ||
| cd ~/BikeHub/api && cp .env.example .env | ||
| ``` | ||
|
|
||
| 6. **Build API:** | ||
| - Build the API using: | ||
| ```bash | ||
| cd ~/BikeHub/api && yarn build | ||
| ``` | ||
|
|
||
| 7. **Build Admin Panel:** | ||
| - Move to the admin directory and start the build process: | ||
| ```bash | ||
| cd ~/BikeHub/admin && yarn build | ||
| ``` | ||
|
|
||
| 8. **Serve Admin Panel:** | ||
| - Use a server to serve the admin panel on port 3002: | ||
| ```bash | ||
| serve -l 3002 -s ~/BikeHub/admin/build | ||
| ``` | ||
|
|
||
| Now, BikeHub is set up locally, and you can access the frontend at http://localhost:3000 and the admin panel at http://localhost:3002. | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| Welcome to BikeHub! Here's a step-by-step guide on how you can make the most of our bike rental platform: | ||
| 1. **Sign Up:** | ||
| - Create your account by signing up on our platform. Simply provide the required details and set up your personal profile. | ||
| 2. **Choose Your Bike:** | ||
| - Browse through our diverse collection of bikes. Whether you're into electric rides or classic cruisers, pick the bike that suits your style and preferences. | ||
|
|
||
| 3. **Select Location:** | ||
| - Choose your desired location for bike pick-up. Our network of hubs is strategically placed for your convenience. | ||
|
|
||
| 4. **Set Start and End Time:** | ||
| - Specify the duration of your ride by setting the start and end times. Enjoy the flexibility to tailor your bike rental to fit your schedule. | ||
|
|
||
| 5. **Process Payment:** | ||
| - Complete the seamless payment process to secure your bike rental. We support secure online payments to make your transaction hassle-free. | ||
|
|
||
| 6. **Generate QR Code:** | ||
| - Once your payment is confirmed, generate a unique QR code that contains all the details of your rental. This code will be your key to unlocking your chosen bike. | ||
|
|
||
| 7. **Unlock Your Bike:** | ||
| - Head to the selected location with your QR code in hand. Our bikes are equipped with a device that reads the QR code, allowing you to effortlessly unlock and begin your journey. | ||
|
|
||
| 8. **Enjoy Your Ride:** | ||
| - Hit the road and enjoy the freedom of two-wheel exploration. Cruise through the city or embark on an adventure—BikeHub is your companion for a memorable ride. | ||
|
|
||
| 9. **Return Your Bike:** | ||
| - Once your ride is complete, return the bike to any BikeHub location. Ensure the bike is securely locked, and your rental will be concluded. | ||
|
|
||
| 10. **Extend or Cancel Anytime:** | ||
| - Need more time or had a change of plans? Extend your rental duration or cancel easily through the platform. | ||
|
|
||
| Experience the joy of cycling with BikeHub—your journey, your bike, your freedom! | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions from the community to make BikeHub even better! Here's how you can get involved: | ||
| 1. **Fork the Repository:** | ||
| - Start by forking the BikeHub repository to your GitHub account. | ||
| 2. **Clone Your Fork:** | ||
| - Clone the forked repository to your local machine using: | ||
| ```bash | ||
| git clone https://github.com/nuuxcode/BikeHub.git | ||
| ``` | ||
| 3. **Create a Branch:** | ||
| - Create a new branch for your contribution: | ||
| ```bash | ||
| git checkout -b feature/your-feature | ||
| ``` | ||
| 4. **Make Your Changes:** | ||
| - Implement bug fixes, new features, or improvements. Ensure your code follows our coding standards. | ||
| 5. **Commit Your Changes:** | ||
| - Commit your changes with descriptive commit messages: | ||
| ```bash | ||
| git commit -m "Description of your changes" | ||
| ``` | ||
| 6. **Push to Your Fork:** | ||
| - Push your changes to your forked repository: | ||
| ```bash | ||
| git push origin feature/your-feature | ||
| ``` | ||
| 7. **Submit a Pull Request:** | ||
| - Open a pull request on the BikeHub repository. Clearly describe your changes, including any relevant context or issues. | ||
| 8. **Review and Merge:** | ||
| - Our team will review your contribution. Once approved, we'll merge your changes into the main branch. | ||
|
|
||
| Thank you for contributing to BikeHub! Your efforts help create an even better biking experience for our users. | ||
|
|
||
| Feel free to reach out if you have any questions or need assistance during the contribution process. | ||
|
|
||
| ## Related Projects | ||
|
|
||
| Explore more bike rental projects that might interest you: | ||
|
|
||
| - [DuaneDave/Bike-rental](https://github.com/DuaneDave/Bike-rental): A versatile bike rental system with a focus on user-friendly features. | ||
|
|
||
| - [youssefsharief/bikes-rental](https://github.com/youssefsharief/bikes-rental): A comprehensive solution for bike enthusiasts, offering a variety of rental options. | ||
|
|
||
| - [gurupratap-matharu/Bike-Rental-System](https://github.com/gurupratap-matharu/Bike-Rental-System): An innovative bike rental system designed for seamless user experiences. | ||
|
|
||
| - [sabbir-hossain-abir/Bike-Rental-System](https://github.com/sabbir-hossain-abir/Bike-Rental-System): A reliable and scalable bike rental platform with robust features. | ||
|
|
||
| - [rugarcialopez/bike-rentals](https://github.com/rugarcialopez/bike-rentals): A modern approach to bike rentals, focusing on performance and user satisfaction. | ||
|
|
||
| - [babroval/bike-rent](https://github.com/babroval/bike-rent): An open-source bike rental solution, perfect for customization and integration. | ||
|
|
||
| Feel free to explore these projects and discover different approaches to bike rental systems. If you have a project to add, please submit a pull request! | ||
|
|
||
| ## Licensing | ||
|
|
||
| BikeHub is distributed under the terms of the [MIT License](https://opensource.org/licenses/MIT), making it free to use, modify, and distribute. This permissive open-source license allows you the flexibility to adapt our project to your needs while promoting collaboration within the community. | ||
|
|
||
| We encourage developers, enthusiasts, and contributors to explore, enhance, and share BikeHub, fostering a spirit of innovation and inclusivity. | ||
|
|
||
| For more details, please refer to the [MIT License](https://opensource.org/licenses/MIT). | ||
|
|
||
| ## Screenshot | ||
|
|
||
|  | ||
|
|
||
| ## Deployment | ||
| Provide a link to your deployed site: [BikeHub](http://bikehub.me/) | ||
|
|
||
| - **Front-end:** React | ||
| - **Back-end:** Nest.js with Fastify | ||
| - **Database:** Postgresql with Prisma | ||
| - **Payment:** Stripe API | ||
| - **QR Code:** QR Code Generator Library | ||
| ## Final Project Blog Article | ||
| Include a link to the final project blog article for more in-depth information. | ||
|
|
||
| ## Author(s) LinkedIn | ||
| - [ITRI M'BARKI](https://www.linkedin.com/in/itri-m-barki-038704232/) | ||
| - [El Gharbi Ayoub](https://www.linkedin.com/in/elgharbiayoub/) | ||
| - [Mounssif nuuX BOUHLAOUI](https://www.linkedin.com/in/mounssif-bouhlaoui-25934570/) |