White Sparrow is a web application for online shopping that is built using Node.js and MongoDB. It is designed to provide users with an easy and convenient shopping experience.
To get started with White Sparrow, you will need to have Node.js and MongoDB installed on your system. Once you have those installed, you can follow these steps:
- Clone the repository to your local machine.
- Navigate to the root directory of the project in your terminal.
- Run the command
npm install
to install all the dependencies. - Create a
.env
file in the root directory of the project and add your environment variables. You can find the required variables in the.env.example
file. - Run the command
npm start
to start the server.
White Sparrow comes with the following features:
- User authentication and authorization
- Product search functionality
- Product filtering by category and price range
- Cart management
- Payment integration with PayPal and Razorpay
- SMS notification using Twilio
- PDF invoice generation for orders
- Analytics using Chart.js
- Voucher code generation
- Pagination using Mongoose-paginate-v2
White Sparrow is built using the following technologies:
- Node.js
- Express.js
- MongoDB
- Mongoose
- EJS
- PayPal Checkout Server SDK
- Razorpay
- Twilio
- Chart.js
- Voucher-code-generator
- Dotenv
- Nodemon
- Multer
- bcrypt
- Easy-currencies
- Express-ejs-layouts
- Express-session
- HTTP-errors
- Morgan
- Sweetalert
White Sparrow is an open-source project and contributions are welcome. If you want to contribute, please follow these steps:
- Fork the repository.
- Create a new branch with a meaningful name.
- Make your changes and commit them with a descriptive message.
- Push your changes to the branch.
- Create a pull request.
White Sparrow is licensed under the MIT license. See the LICENSE file for more information.