Getting Started - 1hemmem/vigilant-meme GitHub Wiki
This page explains how to set up and run the project locally for development or testing.
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-management-platform/
β
βββ backend/ # Express.js API
β βββ package.json
β βββ src/
β βββ .env
β
βββ frontend/ # Vue.js or React frontend
β βββ package.json
β βββ src/
β βββ .env
β
βββ README.md
git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>-
Navigate to the backend folder:
cd backend -
Install dependencies:
npm install
-
Create a
.envfile:touch .env
-
Add the following environment variables:
PORT=5000 MONGO_URI=mongodb://localhost:27017/project_manager JWT_SECRET=yourSecretKey -
Start the backend server:
npm run dev
By default, it runs on: http://localhost:5000
-
Navigate to the frontend folder:
cd ../frontend -
Install dependencies:
npm install
-
Create a
.envfile:VITE_API_URL=http://localhost:5000 -
Start the development server:
npm run dev
Access your app at: http://localhost:5173
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:5000return 200 (OK) - MongoDB Compass should show a new database named
project_manager
You can add unit or integration tests later:
# backend
cd backend
npm run test
# frontend
cd frontend
npm run testTo deploy your app:
| Part | Service | Example |
|---|---|---|
| Backend | Render / Railway | auto-deploy from GitHub |
| Database | MongoDB Atlas | cloud database |
| Frontend | Netlify / Vercel | continuous deployment |
Your local setup should now be running with:
- Frontend: http://localhost:5173
- Backend: http://localhost:5000
- Database: MongoDB local or Atlas
Youβre ready to develop, test, and document your app!
Next: Go to Architecture or Sprints to start planning development.