Skip to content

Latest commit

Β 

History

History
143 lines (95 loc) Β· 2.52 KB

File metadata and controls

143 lines (95 loc) Β· 2.52 KB
# πŸ“¦ S25-Full-Stack-Circle

This project is a collaborative effort by ReDI School full-stack students aimed at improving teamwork, version control practices, and end-to-end development skills.

It simulates a real-world development workflow with collaborative feature development, pull requests, code reviews, and clean, modular code practices.

---

## πŸ“ Project Structure


S25-Full-Stack-Circle/
β”œβ”€β”€ frontend/   # React + Vite + CSS Modules
β”œβ”€β”€ backend/    # Express + Prisma + PostgreSQL
β”œβ”€β”€ scripts/    # Utility scripts for setup and maintenance
└── README.md

πŸš€ Quick Start

1. Clone and Install

git clone https://github.com/ReDI-School/S25-Full-Stack-Circle.git
cd S25-Full-Stack-Circle
npm install

This will automatically install dependencies for both frontend and backend.


2. Configure Environment Variables

In backend/, create a .env file:

DATABASE_URL=""
PORT = 
JWT_SECRET=""
JWT_EXPIRES_IN=

You can use the .env.text as a reference.


3. Start the Project

npm run start

This command:


πŸ”„ If You Change schema.prisma

If you modify backend/prisma/schema.prisma, run:

cd backend
npx prisma migrate dev --name your_migration_name

Or, for a quick dev sync without migration files:

npx prisma db push && npx prisma generate

🌱 (Optional) Seed the Database

cd backend
npm run seed

🏷️ Category System

The app uses a category-based organization system for pins:

  • Each pin can belong to one category
  • Categories are displayed on the Explore page

Seeding Categories

To populate the database with initial categories:

cd backend
node scripts/seed-categories.js

βš™ Tech Stack

  • Frontend: React + Vite + CSS Modules
  • Backend: Node.js + Express
  • Database: PostgreSQL + Prisma ORM

πŸ§ͺ API Testing

  • Use the included Postman collection in postman/
  • Set {{baseUrl}} to: http://localhost:4000

πŸ‘¨β€πŸ’» Contributors

Iman Bajalan
Angelo Centeno
Savitha Muthuramalingam
Sonali Rathod
Daria Parashchenko
Ehighe Aisiri
Marline John
Oluwabusola Ilechukwu
Suleman Ahmed Khan
Bianca Dascalescu
Asligul Safarova
Julita Lapinska
Zakaria Sebai
Muhammad Shehbaz