{"id":20365633,"url":"https://github.com/hackyourfuture/final-project-template","last_synced_at":"2025-07-12T16:36:29.647Z","repository":{"id":45409119,"uuid":"426253195","full_name":"HackYourFuture/final-project-template","owner":"HackYourFuture","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-12T11:49:33.000Z","size":567,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2024-12-12T12:34:29.246Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HackYourFuture.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-09T14:06:59.000Z","updated_at":"2024-12-12T11:49:37.000Z","dependencies_parsed_at":"2024-07-20T12:30:58.227Z","dependency_job_id":null,"html_url":"https://github.com/HackYourFuture/final-project-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackYourFuture%2Ffinal-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackYourFuture%2Ffinal-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackYourFuture%2Ffinal-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackYourFuture%2Ffinal-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HackYourFuture","download_url":"https://codeload.github.com/HackYourFuture/final-project-template/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233990575,"owners_count":18762258,"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":[],"created_at":"2024-11-15T00:19:12.715Z","updated_at":"2025-07-12T16:36:29.641Z","avatar_url":"https://github.com/HackYourFuture.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"`TODO: Add a nice screenshot of the app!`\n\n# Cohort XX final project\n\nThis is the final project for the HackYourFuture curriculum we did as a cohort using the [MERN stack](https://www.mongodb.com/resources/languages/mern-stack) by following the agile methodology with our team and a group of mentors. A quick guide to what we built:\n\n\u003e TODO: Add short description of the app\n\n`[Click here for the Demo version](TODO: add link)`\n\n## 1. Setup\n\nFirst, to setup all the directories run the following in the main directory:\n\n`npm install`\n\n`npm run setup`\n\nThe first command will install `cypress` and some small libraries needed for running the rest of the commands. The second will go into the `client` and `server` directories and set those up to be ran.\n\nIn the `client` and `server` directory there are two `.env.example` files. Create a copy and rename that to `.env`. Then follow the instructions in those files to fill in the right values.\n\nTo run the app in dev mode you can run the following command in the main directory:\n\n`npm run dev`\n\n## 2. Code structure\n\n```\nclient\n├── public\n└── src\n|   └── __tests__\n|   └── __testUtils__\n|   └── components\n|   └── hooks\n|   └── pages\n|       └── __tests__\n|       └── components\n|   └── util\n|   index.jsx\ncypress\n|   └── fixtures\n|   └── integration\n|   └── plugins\n|   └── support\nserver\n└── src\n    └── __tests__\n    └── __testUtils__\n    └── controllers\n    └── db\n    └── models\n    └── routes\n    └── util\n    index.js\n```\n\n### 2.1 Client structure\n\n- `public` || public facing client code\n- `__tests__` || any `jest` tests for specific components will be in a `__tests__` folder on the same level\n- `__testUtils__` || any code that is only being used in the tests is put in the `__testUtils__` folder to separate that away from the rest of the code\n- `components` || all of our shared components that are used over multiple pages\n- `hooks` || all of our custom hooks\n- `pages` || the page components of our app, any routing will go between these components\n- `pages/components` || components used specifically on those pages\n- `util` || any utility functions that can be used anywhere on the client side\n- `main.jsx` || the start point of the client\n- `vite.config.js` || to configure vite\n\n### 2.2 Cypress structure\n\n- `fixtures` || any data/files that `cypress` needs can be placed here\n- `integration` || all of our tests are in here, separated in folders based on the pages in our app\n- `plugins` || any plugins for our `cypress` configuration can be placed here\n- `support` || custom commands and other support files for `cypress` can be placed here\n\n### 2.3 Server structure\n\n- `__tests__` || any `jest` tests for the api endpoints as that is our testing strategy for the backend\n- `__testUtils__` || any code that is only being used in the tests is put in the `__testUtils__` folder to separate that away from the rest of the code\n- `controllers` || all of our controller functions that interact with the database\n- `db` || all of our configuration for the database\n- `models` || all of our `mongoose` models will be placed here\n- `routes` || code to match up the API with our controllers\n- `util` || any utility functions that can be used anywhere on the server side\n- `index.js` || the start point of the server\n\n## 3. Stack / external libraries\n\nThe base stack of the app is a MERN stack (Mongoose, Express, React, Node). Next to that we make use of the following extras:\n\n### 3.1 Configuration libraries\n\n- `dotenv` || To load the .env variables into the process environment. See [docs](https://www.npmjs.com/package/dotenv)\n- `vite` || To bundle our React app and create a static app to host. See [docs](https://vite.dev/)\n- `husky` || To run our tests and linter before committing. See [docs](https://typicode.github.io/husky/#/)\n- `eslint` || To check our code. We have different configurations for frontend and backend. You can check out the configuration in the `.eslintrc.(c)js` files in the respective `client` and `server` folders. See [docs](https://eslint.org/)\n- `prettier` || To automatically format our code. See [docs](https://prettier.io/)\n- `concurrently` || To run commands in parallel. See [docs](https://github.com/open-cli-tools/concurrently#readme)\n\nFor more information on how these work together including the automatic deployment to heroku, have a look at our detailed [DEV](./DEV.md) file.\n\n### 3.2 Client-side libraries\n\n- `@testing-library/*` || We use React Testing Library to write all of our tests. See [docs](https://testing-library.com/docs/react-testing-library/intro/)\n- `jest` || To run our tests and coverage. See [docs](https://jestjs.io/)\n- `jest-fetch-mock` || To mock out the backend for our testing purposes. See [docs](https://github.com/jefflau/jest-fetch-mock#readme)\n- `prop-types` || To type-check our components. See [docs](https://github.com/facebook/prop-types)\n\n### 3.3 Server-side libraries\n\n- `nodemon` || To automatically restart the server when in development mode. See [docs](https://nodemon.io/)\n- `jest` || To run our tests and coverage. See [docs](https://jestjs.io/)\n- `supertest` || To more easily test our endpoints. See [docs](https://github.com/visionmedia/supertest#readme)\n- `mongodb-memory-server` || To mock out our database in our backend tests. See [docs](https://github.com/nodkz/mongodb-memory-server)\n- `cors` || To open up our API. See [docs](https://github.com/expressjs/cors#readme)\n- `mongoose` || To add schemas to our database. See [docs](https://mongoosejs.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackyourfuture%2Ffinal-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackyourfuture%2Ffinal-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackyourfuture%2Ffinal-project-template/lists"}