https://github.com/webdevbynight/cr-hack-ers
This repository is a 48-hour hackathon made during a course at Wild Code School. This is a team project with contributions from me, @AnneL51100, @nguyen-tt, @SEF936 and @Zanelidd.
https://github.com/webdevbynight/cr-hack-ers
hackathon wildcodeschool
Last synced: 2 months ago
JSON representation
This repository is a 48-hour hackathon made during a course at Wild Code School. This is a team project with contributions from me, @AnneL51100, @nguyen-tt, @SEF936 and @Zanelidd.
- Host: GitHub
- URL: https://github.com/webdevbynight/cr-hack-ers
- Owner: webdevbynight
- License: mit
- Created: 2023-05-11T11:10:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T14:48:23.000Z (3 months ago)
- Last Synced: 2025-02-25T15:41:41.929Z (3 months ago)
- Topics: hackathon, wildcodeschool
- Language: SCSS
- Homepage: https://merbnb.vercel.app
- Size: 13.2 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Merbnb (by CR{hack}ERS)
This repository is a 48-hour hackathon made during a course at Wild Code School. This is a team project with contributions from me, [@AnneL51100](https://github.com/AnneL51100), [@nguyen-tt](https://github.com/nguyen-tt), [@SEF936](https://github.com/SEF936) and [@Zanelidd](https://github.com/Zanelidd).
The project is based on React and uses two Flickr APIs.
## Setup & Use
### Project Initialization
- In VSCode, install plugins **Prettier - Code formatter** and **ESLint** and configure them
- Clone this repo, enter it
- If you are using `yarn` or `pnpm`, adapt the `config/cli` in `package.json`
- Run command `npm install`
- _NB: To launch the backend server, you'll need an environment file with database credentials. You'll find a template one in `backend/.env.sample`_
### Available Commands
- `migrate` : Run the database migration script
- `dev` : Starts both servers (frontend + backend) in one terminal
- `dev-front` : Starts the React frontend server
- `dev-back` : Starts the Express backend server
- `lint` : Runs validation tools, and refuses unclean code (will be executed on every _commit_)
- `fix` : Fixes linter errors (run it if `lint` growls on your code !)
## FAQ
### Tools
- _Concurrently_ : Allows for several commands to run concurrently in the same CLI
- _Husky_ : Allows to execute specific commands that trigger on _git_ events
- _Vite_ : Alternative to _Create-React-App_, packaging less tools for a more fluid experience
- _ESLint_ : "Quality of code" tool, ensures chosen rules will be enforced
- _Prettier_ : "Quality of code" tool as well, focuses on the styleguide
- _ Airbnb Standard_ : One of the most known "standards", even though it's not officially linked to ES/JS
- _Nodemon_ : Allows to restart the server everytime a .js file is udated
### Deployment
For deployment, you have to go to `secrets` → app `actions` on the github repo to insert via `New repository secret` :
- CAPROVER_BACK_APPNAME : name app on caprover
- CAPROVER_FRONT_APPNAME : name app on caprover
- CAPROVER_PASSWORD : password caprover
- CAPROVER_SERVER : link of domain