Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

Latest commit

 

History

History
96 lines (67 loc) · 1.33 KB

README.md

File metadata and controls

96 lines (67 loc) · 1.33 KB

Grizzl 🐻

Grizzl is a simple project to learn how to use React and Node.

Description 📝

This application is a Twitter like application. You can create an account, post and comment on posts.

Tech stack 🛠️

Frontend

  • Vite ⚡
  • React ⚛️
  • TailwindCSS + DaisyUI 🍃
  • Iconoir 😎
  • React Router 🛣️
  • MobX 🧬
  • ESLint 🧹

Backend

  • Node 🟩
  • Express 🚂
  • Cors 🌐
  • Mongoose 🍃
  • JWT 🍪
  • Bcrypt 🔒

Common

  • Prettier 🧼

Installation 📥

Install pnpm (if not already installed)

npm install -g pnpm

Frontend

cd app
pnpm install
# or
npm install

Backend

pnpm install
# or
npm install

In the app folder, rename the .env.example file to .env and fill it with your own values.

VITE_API_URL=http://localhost:<backend-port>

In the root folder, rename the .env.example file to .env and fill it with your own values.

PORT=<port>
MONGODB_URI=<your_mongodb_uri>
MONGODB_USER=<your_mongodb_user>
MONGODB_PASS=<your_mongodb_pass>
JWT_SECRET=<jwt_secret>
SALT_ROUNDS=<salt_rounds>
APP_URL=<app_url>

Getting started 🏁

Frontend

cd app
pnpm dev

and go to http://localhost:5173

Backend

pnpm dev

Postman 🟠

You can find the Postman collections in the api/postman folder.