Step up your shoe game with Urban Stride - Where Style Meets Motion!
Urban Stride is a dynamic sports shoe e-commerce platform developed with TypeScript, Node.js, EJS, and MongoDB. This project serves as a practice ground for honing skills in modern web development.
- 🛍️ Curated collection of trendy sports shoes
- 🛒 Seamless e-commerce experience with Stripe integration
- 📄 PDF invoice generation using PDFKit
- ✉️ Email notifications powered by Nodemailer
- 🔒 Secure user sessions and cookies management + CSRF Protection
- 🌐 RESTful API for smooth interactions
- 📊 MongoDB for efficient data storage and retrieval
Enhance your debugging experience with Urban Stride's custom logger utility! This lightweight and versatile logging module is designed for effective debugging and logging within your Node.js applications. The custom logger utility includes:
-
Customizable Logging Levels: Supports three logging levels -
log,warn, anderror, each associated with unique styling for improved readability. -
File, Line, and Column Information: Intelligently captures and displays the file name, line number, and column number of the calling code for detailed log origin information.
-
Styling Options: Leverages the
chalklibrary to apply styling to log messages, making it easy to distinguish between different log levels. -
Flexible Usage: A single, smart, and scalable function accommodates various content types, including strings, objects, and error messages. Adapts its behavior based on the provided content and log level.
-
Ease of Integration: Easy to integrate into Node.js projects for seamless logging during development and production.
import { log, warn, error } from './path-to-logger/logger';
// Example usage:
log('This is a log message.');
warn('This is a warning.');
error('This is an error.');
// You can also use it with variables and objects:
const obj = { key: 'value' };
log('Object:', obj);
error(new Error('This is an error object.'));- Backend: Node.js, Express.js
- Frontend: HTML, CSS, EJS, JavaScript
- Database: MongoDB with Mongoose ODM
- Additional Tools: Stripe, PDFKit, Nodemailer, and many more!
- Users can create an account using their email. They will receive a welcome email once the account is successfully created.
- They can use the same email to reset their password. A password reset link will be provided in that email, which will be valid for only 3 hours.
- They can create a product that they want to sell, and it will be listed on the Products page. An authenticated user can perform edit and delete operations only on the products that belong to that user.
- An authenticated user can also add products from the Product page to their cart. And later, they can also buy it. They'll be redirected to the payment page where they can enter their credit card details (don't enter your real credentials, use the dummy credentials that are provided here) and as soon as the transaction completes, they are redirected to the Orders page.
- And there they can also download the order receipt which will be generated on the fly.
- Besides all that, it utilizes all the latest features like data streaming, utilization of meaningful status codes, pagination, input and file validation, async/await syntax and best practices for writing code that is flexible and re-usable and which is easily testable and maintainable.
-
First, clone the repo by running
git clone [email protected]:AmaaelTyrneaMitore/UrbanStride.git. -
Install dependencies using
npm install. -
Now setup environment variables for MongoDB by creating
nodemon.dev.json(for development) andnodemon.prod.json(for production) at the project root and populate them with the followong content:{ "env": { "MONGO_USER": "", // username for MongoDB database "MONGO_PASS": "", // password for MongoDB database "MONGO_DEFAULT_DB": "", // name of the database "SESSION_SECRET": "", // secret for hashing session cookie "GMAIL_USER": "", // gmail email id "GMAIL_PASS": "", // gmail app password (not login password) "STRIPE_KEY": "", // stripe auth key "NODE_ENV": "", // 'development' or 'production' "DOMAIN": "", // 'http://localhost:3000' or your production domain } }
-
Now you can set all the environment variables that you want to use during development in
nodemon.dev.jsonand running thenpm run start:devcommand will spin up a development server onhttp://localhost:3000/using this config file. And running thenpm run start:prodcommand will spin up the production server on the same port which will use thenodemon.prod.jsonconfig file, so make sure to set the"NODE_ENV"to"development"innodemon.dev.jsonfile, and set this to"production"innodemon.prod.jsonfile.NOTE: In the mentioned approach, it is suggested to use npm run start:prod to utilize environment variables from the nodemon.prod.json file. However, it is important to note that this recommendation is specifically for testing purposes on your local machine. This allows you to assess the production flow before actual deployment. During deployment, it's worth mentioning that many hosting providers furnish a front-end interface for configuring these environment variables. Therefore, the aforementioned approach is primarily designed for local testing purposes.
You can read all about it in Stripe's official documentation on testing your API keys.
- Visit the website, browse the catalog, and add products to your cart.
- Proceed to checkout, complete the payment using Stripe, and download a PDF invoice!
We welcome contributions! Please feel free to drop your suggestions or make PRs if required.
This project is licensed under the GPL-3.0 License.
- Special thanks to the amazing communities of Node.js, Express.js, and MongoDB.
- Hat tip to the creators of Stripe, PDFKit, and Nodemailer for their invaluable tools.
Feel free to reach out at [email protected] for any questions or feedback!
Happy Striding! 🏃♂️👟