github-world192 / wp1121

112-1-unit1-trello-clone

Run the app

Follow the instructions in this section to run the app locally.

1. setup backend .env

Start by copying the .env.example file to .env.

cd backend
cp .env.example .env

Then, fill in the MONGO_URL field in .env with your MongoDB connection string and fill in the PORT field with the port you want to use. After that, you're .env file should look like this. If you don't want to use MongoDB Atlas, you can also run a local MongoDB server with Docker. You can find the instructions here.

PORT=8000
MONGO_URL="mongodb+srv://<username>:<password>@<cluster>.example.mongodb.net/?retryWrites=true&w=majority"

2. setup frontend .env

Start by copying the .env.example file to .env.

cd frontend
cp .env.example .env

Then, fill in the VITE_API_URL field in .env with the url of your backend server. After that, you're .env file should look like this. Note that the port should be the same as the one you set in the backend .env file.

VITE_API_URL="http://localhost:8000/api"

3. start the backend server

cd backend
yarn dev

4. start the frontend server

cd frontend
yarn dev

Visit http://localhost:5173 to see the app in action. That's it, you're done! If you want to set up the whole project from scratch, you can follow the instructions below.

eslint and prettier

The setup process is very similar to the one in the previous project. However, please keep in mind that we use different configuration files this time, frontend configuration is also different from that of backend, this may effect your homework grade. The required plugins can be found in package.json, if you can't run the linter or formatter, make sure you have all of the plugins installed correctly.

The lint script is required in homeworks, please add these lines in your package.json.

{
...
  "scripts": {
    "lint": "eslint src",
    "format": "prettier --write src"
  }
...
}

Frontend Setup

1. Create a vite project

yarn create vite will create a new directory, which is the frontend directory, for you with everything set up. You'll need to answer a few questions to set up the project. If you don't understand some of them, don't worry, just follow the suggestions listed below. You'll (hopefully) understand all these questions as the course progresses.

$ cd frontend
$ yarn create vite
yarn create v1.22.19
[1/4] 🔍  Resolving packages...
[2/4] 🚚  Fetching packages...
[3/4] 🔗  Linking dependencies...
[4/4] 🔨  Building fresh packages...
success Installed "create-vite@4.4.1" with binaries:
      - create-vite
      - cva
? Project name: › vite-project # type `frontend` here
? Select a framework: › - Use arrow-keys. Return to submit.
    Vanilla
    Vue
❯   React # choose React
    Preact
    Lit
    Svelte
    Solid
    Qwik
    Others
? Select a variant: › - Use arrow-keys. Return to submit.
❯   TypeScript # choose TypeScript
    TypeScript + SWC
    JavaScript
    JavaScript + SWC

That's it, you're done. You can now start the dev server by running yarn dev.

Backend Setup

1. Create a backend folder

mkdir backend

2. Create a package.json file

cd backend
yarn init -y

3. Install dependencies

yarn add express cors mongoose dotenv body-parser

4. Typescript setup

yarn add -D ts-node typescript @types/cors @types/node @types/express

-D flag means that the package is a dev dependency. It is only used during development and not in production.

Then we create a tsconfig.json file

yarn tsc --init

We want to use the types defined in the lib folder. To make our lives easier, we can add the following line to tsconfig.json. Now we can import from @lib/* instead of ../../../lib/*.

{
  "compilerOptions": {
    ...
    "@lib/*": ["../lib/*"],
    ...
  }
}

5. Create an entry point

mkdir src
touch src/index.ts

6. Add scripts to package.json

"scripts": {
  "dev": "nodemon src/index.ts",
  "start": "ts-node src/index.ts",
  "lint": "eslint src",
  "format": "prettier --write src"
}

API documentation

card

GET /api/cards

• request body

no body

• response

[
  {
    "id": "a4d603bc-5fcf-4f0d-9765-5430ac8e2602",
    "title": "Card 1",
    "description": "This is card 1",
    "list_id": "d31df21d-e9ad-4b18-998a-564614599aa2"
  },
  {
    "id": "a4d603bc-5fcf-4f0d-9765-5430ac8e2602",
    "title": "Card 2",
    "description": "This is card 2",
    "list_id": "d31df21d-e9ad-4b18-998a-564614599aa2"
  }
]

GET /api/cards/:id

• request body

no body

• response

{
  "id": "a4d603bc-5fcf-4f0d-9765-5430ac8e2602",
  "title": "Card 1",
  "description": "This is card 1",
  "list_id": "d31df21d-e9ad-4b18-998a-564614599aa2"
}

POST /api/cards

• requst body

{
  "title": "Card 1",
  "description": "This is card 1",
  "list_id": "d31df21d-e9ad-4b18-998a-564614599aa2"
}

• response

{
  "id": "a4d603bc-5fcf-4f0d-9765-5430ac8e2602"
}

PUT /api/cards/:id

• requst body

{
  "title": "Card 1",
  "description": "This is card 1",
  "list_id": "d31df21d-e9ad-4b18-998a-564614599aa2"
}

• response

OK

DELETE /api/cards/:id

• request body

no body

• response

OK

list

GET /api/lists

• request body

no body

• response

[
  {
    "id": "d31df21d-e9ad-4b18-998a-564614599aa2",
    "name": "List 1"
  }
]

GET /api/lists/:id

• request body

no body

• response

{
  "id": "d31df21d-e9ad-4b18-998a-564614599aa2",
  "name": "List 1",
  "cards": [
    {
      "id": "a4d603bc-5fcf-4f0d-9765-5430ac8e2602",
      "title": "Card 1",
      "description": "This is card 1",
      "list_id": "d31df21d-e9ad-4b18-998a-564614599aa2"
    }
  ]
}

POST /api/lists

• requst body

{
  "name": "List 1"
}

• response

{
  "id": "d31df21d-e9ad-4b18-998a-564614599aa2"
}

PUT /api/lists/:id

• requst body

{
  "name": "List 1"
}

• response

OK

DELETE /api/lists/:id

• request body

no body

• response

OK