{"id":19249939,"url":"https://github.com/iv0ks/devcamp","last_synced_at":"2026-04-02T02:51:28.786Z","repository":{"id":209008077,"uuid":"723003705","full_name":"gucasassi/devcamp","owner":"gucasassi","description":"Welcome to the Devcamp, a comprehensive bootcamp management application built with the MERN stack (MongoDB, Express.js, React, Node.js). It's designed to streamline the management of coding bootcamps, enhancing the experience for administrators, instructors, and students.","archived":false,"fork":false,"pushed_at":"2023-12-16T17:08:55.000Z","size":218,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-05T06:17:52.546Z","etag":null,"topics":["bcryptjs","cookie-parser","dotenv","express","express-rate-limit","helmetjs","hpp","jsonwebtoken","mern-stack","mongo-sanitize","mongodb","mongoose","morgan","nodejs","nodemailer","reactjs"],"latest_commit_sha":null,"homepage":"https://devcamp.gucasassi.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gucasassi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-24T12:59:21.000Z","updated_at":"2023-12-15T16:15:52.000Z","dependencies_parsed_at":"2023-12-11T13:42:27.459Z","dependency_job_id":null,"html_url":"https://github.com/gucasassi/devcamp","commit_stats":null,"previous_names":["gucasassi/devcamp"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucasassi%2Fdevcamp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucasassi%2Fdevcamp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucasassi%2Fdevcamp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gucasassi%2Fdevcamp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gucasassi","download_url":"https://codeload.github.com/gucasassi/devcamp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240341701,"owners_count":19786346,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bcryptjs","cookie-parser","dotenv","express","express-rate-limit","helmetjs","hpp","jsonwebtoken","mern-stack","mongo-sanitize","mongodb","mongoose","morgan","nodejs","nodemailer","reactjs"],"created_at":"2024-11-09T18:15:47.111Z","updated_at":"2026-04-02T02:51:28.755Z","avatar_url":"https://github.com/gucasassi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Node.js](https://img.shields.io/badge/node.js-24.10.0-339933.svg?style=flat\u0026logo=node.js\u0026logoColor=white)](https://nodejs.org/)\n[![PNPM](https://img.shields.io/badge/pnpm-10.19.0-F9AD0B?label=pnpm\u0026style=flat\u0026logo=pnpm\u0026logoColor=white)](https://pnpm.io/)\n[![GitHub Release](https://img.shields.io/github/v/release/gucasassi/devcamp?label=release\u0026style=flat)](https://github.com/gucasassi/devcamp/releases/latest)\n[![Status](https://img.shields.io/github/actions/workflow/status/gucasassi/devcamp/release.yml?label=status\u0026style=flat)](https://github.com/gucasassi/devcamp/actions/workflows/release.yml)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gucasassi_devcamp\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gucasassi_devcamp)\n\n# DevCamp API\n\nAn API built entirely with **Node.js** and **Express** designed to streamline the administration and delivery of educational bootcamps and courses. This project serves as a comprehensive demonstration of building **scalable and secure** backend systems.\n\n## 📋 Setup (Local Development)\n\nFollow these steps to configure and run the project in your local environment.\n\n### Prerequisites\n\nEnsure your development environment has the following tools installed with the recommended versions:\n\n- [Node.js](https://nodejs.org/): `v24.10.0` or greater.\n- [PNPM](https://pnpm.io/): `v10.19.0` or greater.\n- [Docker](https://www.docker.com/): Required to run the database locally.\n\nReady to get started? Just follow the next sections to [set up](#set-up) your environment.\n\n### 1. Clone the Repository\n\nOpen your terminal and clone the project:\n\n```sh\ngit clone https://github.com/gucasassi/devcamp.git \u0026\u0026 cd devcamp\n```\n\n### 2. Install Dependencies\n\nUse PNPM to install all project dependencies:\n\n```sh\npnpm i\n```\n\n### 3. Configure the Database (MongoDB)\n\nTo simplify local development, it is recommended to use the provided `docker-compose.yml` file to start **MongoDB** in a container. Start the database container:\n\n```sh\ndocker compose up -d mongodb\n```\n\n\u003e Note: The MongoDB instance will be accessible at mongodb://172.17.0.1:27017.\n\n### 4. Environment Variables\n\nCreate a `.env` file in the project root to store your environment variables. Use the following example as a template:\n\n```sh\nNODE_ENV=development\nAPP_PORT=3000\n# Ensure this URI matches your Docker container's address.\nMONGO_URI=mongodb://172.17.0.1:27017/devcamp\n```\n\n### 5. Seed the Database (Required)\n\nBefore running the application, you must seed the database with sample data. Run the following command from the project root:\n\n```sh\npnpm seed\n```\n\nThis will insert the data from the files in the `_data` folder into your configured database.\n\n### 6. Running the Project\n\nOnce the setup and seeding are complete, you can start the API in development mode:\n\n```sh\n# Starts the server using nodemon for automatic restarts.\npnpm dev\n```\n\nThe API will be running at `http://localhost:3000` (or the port specified in your .env file).\n\n## ▶️ Run with Docker\n\nIf you just want to test the API without a full local installation, you can directly run the [Docker](https://www.docker.com/) image from [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) (GHCR).\n\n### 1. Get the Setup Files\n\nYou need the `docker-compose.yml` (for MongoDB) and create the `.env` file.\n\n```sh\ngit clone https://github.com/gucasassi/devcamp.git \u0026\u0026 cd devcamp\n```\n\nCreate the `.env` file.\n\n```sh\nnano .env\n```\n\nContent for `.env`:\n\n```sh\nNODE_ENV=production\nAPP_PORT=3000\nMONGO_URI=mongodb://172.17.0.1:27017/devcamp\n```\n\n### 2. Start the Database\n\nEnsure the `mongodb` container is running locally using `docker compose`:\n\n```sh\ndocker compose up -d mongodb\n```\n\n### 3. Seed the Database (Required)\n\nBefore running the application, you must seed the database with sample data. Run the following command from the project root:\n\n```sh\npnpm seed\n```\n\nThis will insert the data from the files in the `_data` folder into your configured database.\n\n### 4. Run the API\n\nPull and run the latest stable image of `devcamp`, mapping the application port `3000` and using your local `.env` file for configuration.\n\n```sh\ndocker run -dit \\\n  -p 3000:3000 \\\n  --name devcamp \\\n  --env-file .env \\\n  ghcr.io/gucasassi/devcamp:latest\n```\n\nThe API will be accessible at `http://localhost:3000`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiv0ks%2Fdevcamp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiv0ks%2Fdevcamp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiv0ks%2Fdevcamp/lists"}