Getting Started - 1hemmem/vigilant-meme GitHub Wiki

Getting Started – Installation & Setup Guide

This page explains how to set up and run the project locally for development or testing.


Prerequisites

Before starting, make sure you have these installed:

Tool Version Link
Node.js v18+ Download Node.js
npm or yarn latest Included with Node.js
MongoDB v6+ Download MongoDB
Git latest Download Git
VSCode recommended Download VSCode

Project Structure


project-management-platform/
β”‚
β”œβ”€β”€ backend/           # Express.js API
β”‚   β”œβ”€β”€ package.json
β”‚   β”œβ”€β”€ src/
β”‚   └── .env
β”‚
β”œβ”€β”€ frontend/          # Vue.js or React frontend
β”‚   β”œβ”€β”€ package.json
β”‚   β”œβ”€β”€ src/
β”‚   └── .env
β”‚
└── README.md


1. Clone the Repository

git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>

2. Backend Setup (Node.js + Express)

  1. Navigate to the backend folder:

    cd backend
  2. Install dependencies:

    npm install
  3. Create a .env file:

    touch .env
  4. Add the following environment variables:

    PORT=5000
    MONGO_URI=mongodb://localhost:27017/project_manager
    JWT_SECRET=yourSecretKey
    
  5. Start the backend server:

    npm run dev

    By default, it runs on: http://localhost:5000


πŸ’» 3. Frontend Setup (Vue.js or React)

  1. Navigate to the frontend folder:

    cd ../frontend
  2. Install dependencies:

    npm install
  3. Create a .env file:

    VITE_API_URL=http://localhost:5000
    
  4. Start the development server:

    npm run dev

    Access your app at: http://localhost:5173


4. Test the Connection

Once both servers are running:

  • Open your browser and visit http://localhost:5173
  • Create a new account
  • Open browser console β†’ ensure API calls to http://localhost:5000 return 200 (OK)
  • MongoDB Compass should show a new database named project_manager

5. Running Tests

You can add unit or integration tests later:

# backend
cd backend
npm run test

# frontend
cd frontend
npm run test

6. Optional – Deploy Online

To deploy your app:

Part Service Example
Backend Render / Railway auto-deploy from GitHub
Database MongoDB Atlas cloud database
Frontend Netlify / Vercel continuous deployment

Summary

Your local setup should now be running with:

You’re ready to develop, test, and document your app!


Next: Go to Architecture or Sprints to start planning development.

⚠️ **GitHub.com Fallback** ⚠️