Quick Overview

J-SNKRS — yours way into sneakers! Nike SNKRS from JAPAN

The online marketplace that offers you a high variety of sneakers.

• In this version, back-end and front-end work on the same domain without any CORS policy issues. REST API is available at the /api subpath.

Tech Stack

Front-end: React + Vite, Redux, SASS & SCSS, Tailwind CSS, shadcn/ui.
Back-end: Express.js, Redis, MySQL.

Dependencies

• Install Git on your machine to clone the Github repository.
• Install Node.js on your machine to build and run the application locally.

Clone Repository

Create a new directory where you want to deploy the application, then clone the Github repository into it:

git clone https://github.com/artndev/j-snkrs.git .

Navigate to the project directory:

cd root

Change the working branch from master (production branch) to dev-public (public development branch) due to the specialties of the production and development environments:

git checkout dev-public

Configure Environmental Variables

Open the .env.local file located in the /client directory and fill in the required environmental variables:

# Your Stripe credentials can be found at:
# https://dashboard.stripe.com/test/dashboard
# https://dashboard.stripe.com/test/settings/user
VITE_STRIPE_PUBLISHABLE_KEY=...
VITE_STRIPE_ACCOUNT_ID=...

Open the .env.local file located in the /server directory and fill in the required environmental variables:

# Table schemas can be found in server\src\schemas folder
# They are needed to create the same environment as mine

# Your Redis credentials
REDIS_URL=...

# Your Stripe credentials can be found at:
# https://dashboard.stripe.com/test/dashboard
STRIPE_SECRET=...

# UUIDv4 secrets used for access to secured destinations
SESSION_SECRET=...
JWT_SECRET=...
MAGIC_LINK_SECRET=...

PORT=8000

# Your Google credentials can be found at:
# https://console.cloud.google.com
# Fill in the authorization callback URL field:
# http://localhost:8000/api/google/callback
GOOGLE_API_KEY=...
GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...

# Your Github credentials can be found at:
# https://github.com/settings/developers
# Fill in the authorization callback URL field:
# http://localhost:8000/api/github/callback
GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...

# The bot SMTP email credentials to send verification and confirmation emails
NODEMAILER_USER=...
NODEMAILER_PASSWORD=...

# Your DB credentials
MYSQL_HOST=...
MYSQL_PORT=...
MYSQL_USER=...
MYSQL_PASSWORD=...
MYSQL_DBNAME=...

Useful Links

• UUIDv4 generator
• Postmaster (totally free but not suitable for the production)
• Sendgrid
• Mailgun

Run Application with Node.js

Return to the root directory:

cd ../

Use the command below to build and run the application with Node.js:

npm run start

Access Application

Once the application is started successfully, it will be available at http://localhost:8000.