SignumLBRI is a comprehensive bookshop website designed specifically for school book fairs. The platform aims to provide an efficient and user-friendly solution for selling and managing school books. This README provides an overview of the project, its technologies, and instructions for setting up and running the application.
- Node.js
- TypeScript
- Pug.js
- Tailwind CSS
- Webpack
- MongoDB
- User registration and authentication
- Book listing and search functionality
- Seller management for adding, editing, and removing books
- Seamless stationary checkout process
- Responsive design for optimal user experience across devices
To get started with SignumLBRI, follow these steps:
- Clone the repository:
git clone https://github.com/PiRifle/SignumLBRI.git
- Install dependencies:
cd SignumLBRI
npm install
- Set up the environment variables:
Create a .env file in the project root directory and configure the following variables:
PORT=3000
MONGODB_URI=<your-mongodb-connection-string>
MAIL_HOST=<your-mail-host>
MAIL_USER=<your-mail-user>
MAIL_PASSWORD=<your-mail-password>
SESSION_SECRET=<your-session-secret>
- Build the application:
npm run build
- Start the server:
npm start
- Open the application in your browser:
http://localhost:3000
SignumLBRI also provides a Docker Compose file for easy deployment and containerization. To use Docker Compose, make sure you have Docker installed on your machine, and follow these steps:
-
Make sure you are in the project directory.
-
Build and start the containers:
docker-compose up --build- Access the application in your browser at
http://localhost:3000.
Contributions are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue in the GitHub repository.
This project is licensed under the MIT License.
For any inquiries or further information, please reach out to Piotr Czirnia at [email protected]
Let's make book fairs more efficient and enjoyable with SignumLBRI!