https://github.com/bartek-figat/---bbards---
Our project is an e-commerce platform enabling users to buy, rent and book anything. The platform's Frontend is developed with TypeScript, React and Tailwind and the Backend is created with TypeScript, Express, Docker and MongoDb. It is an open source project and we do it non-profit. Our goal is to develop our skills and gain experience.
https://github.com/bartek-figat/---bbards---
docker expressjs hacktoberfest mongodb nginx nodejs react tailwindcss typescript
Last synced: about 1 year ago
JSON representation
Our project is an e-commerce platform enabling users to buy, rent and book anything. The platform's Frontend is developed with TypeScript, React and Tailwind and the Backend is created with TypeScript, Express, Docker and MongoDb. It is an open source project and we do it non-profit. Our goal is to develop our skills and gain experience.
- Host: GitHub
- URL: https://github.com/bartek-figat/---bbards---
- Owner: Bartek-Figat
- Created: 2022-08-02T03:10:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T03:36:30.000Z (over 1 year ago)
- Last Synced: 2025-03-31T16:13:11.796Z (about 1 year ago)
- Topics: docker, expressjs, hacktoberfest, mongodb, nginx, nodejs, react, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 54.6 MB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## Table of Contents
[](#contributors-)
- [Download](#Download)
- [Installation](#Installation)
- [Docker compose](#Docker)
- [Modules](#Modules)
- [API Documentation](#API)
- [Contributing](#Contributing)
- [Application demo](https://bartek-figat.github.io/---BBARDS---/)
## Buy Me Coffee
[Coffee](https://www.buymeacoffee.com/bartek1983d)
## Download
```bash
https://github.com/Bartek-Figat/---BBARDS---.git
```
## Installation
Use the following script to install modules in the front-end and back-end directory
```bash
yarn install
```
To run the project, in the root directory use.
The command will start the front-end and back-end
```bash
yarn start
```
## Docker
If you want to code using Docker, create `.env` file in root directory:
```bash
MONGO_INITDB_ROOT_USERNAME=developer
MONGO_INITDB_ROOT_PASSWORD=password
MONGO_INITDB_DATABASE=bbardslocal
dbDEV=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@database/${MONGO_INITDB_DATABASE}?retryWrites=true&w=majority&authSource=admin
```
Then run below in the root directory
```bash
docker compose up
```
Docker will bind ports:
3000 - Frontend
8080 - Backend
27017 - MongoDb
If you want to use other ports, open and modify the file `docker-compose.yml`
You can also run specific services:
`docker compose up backend` - will run backend service and mongodb
`docker compose up frontend` - will run frontend service
## Modules
Modules installation
```bash
yarn workspace
```
Example:
```bash
yarn workspace @bbards-ts/front-end add react react-dom --dev
```
```bash
yarn workspace @bbards-ts/back-end add cors
```
If you want to remove a package:
```bash
yarn workspace web-project remove some-package
```
## API
Swaggier API
Open [http://localhost:8080/api-docs/](http://localhost:8080/api-docs/) in the browser.
## Contributing
Look at our [CONTRIBUTING.md](https://github.com/Bartek-Figat/tsx-react/blob/main/CONTRIBUTING.md) file to learn how to get started with gitflow.
## Contributors ✨
Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
adrianixGit
📖
Bartlomiej Komendarczuk
📖
jsgostkowski
📖
kuprelweronika
📖
masterHAWK99
📖
Aleksander Skorek
📖
Add your contributions
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!