Backend and Frontend Template

Latest version: https://git.chalmers.se/courses/dit342/group-00-web

This template refers to itself as group-20-web. In your project, use your group number in place of 20.

Project Structure

File	Purpose	What you do?
server/	Backend server code	All your server code
server/README.md	Everything about the server	READ ME carefully!
client/	Frontend client code	All your client code
client/README.md	Everything about the client	READ ME carefully!
docs/DEPLOYMENT.md	Free online production deployment	Deploy your app online in production mode
docs/LOCAL_DEPLOYMENT.md	Local production deployment	Deploy your app local in production mode

Requirements

The version numbers in brackets indicate the tested versions but feel free to use more recent versions. You can also use alternative tools if you know how to configure them (e.g., Firefox instead of Chrome).

• Git (v2) => installation instructions
  • Add your Git username and set your email
    • git config --global user.name "YOUR_USERNAME" => check git config --global user.name
    • git config --global user.email "email@example.com" => check git config --global user.email

  • Windows users: We recommend to use the Git Bash shell from your Git installation or the Bash shell from the Windows Subsystem for Linux to run all shell commands for this project.

• Chalmers GitLab => Login with your Chalmers CID choosing "Sign in with" Chalmers Login. (contact support@chalmers.se if you don't have one)
  • DIT342 course group: https://git.chalmers.se/courses/dit342
  • Setup SSH key with Gitlab
    • Create an SSH key pair ssh-keygen -t ed25519 -C "email@example.com" (skip if you already have one)
    • Add your public SSH key to your Gitlab profile under https://git.chalmers.se/profile/keys
    • Make sure the email you use to commit is registered under https://git.chalmers.se/profile/emails
  • Checkout the Backend-Frontend template git clone git@git.chalmers.se:courses/dit342/group-00-web.git
• Server Requirements
• Client Requirements

Getting started

# Clone repository
git clone git@git.chalmers.se:courses/dit342/group-00-web.git

# Change into the directory
cd group-00-web

# Setup backend
cd server && npm install
npm run dev

# Setup frontend
cd client && npm install
npm run serve

Check out the detailed instructions for backend and frontend.

Visual Studio Code (VSCode)

Open the server and client in separate VSCode workspaces or open the combined backend-frontend.code-workspace. Otherwise, workspace-specific settings don't work properly.

System Definition (MS0)

Purpose

The system provides a recipe sharing platform. People can post recipes on the site. Publishers (i.e., those who post recipes) can offer fixed-price instructional courses that provide specific instructions on how to properly cook the posted dishes. The courses can be physical or remote. The system provides a social platform for chefs or foodies since they can interact in person.

Pages

• Home : User can view all posts and have the option to create their own posts
• View All Posts : User can view all global posts
• Create Post : User can make a new post which will appear on their profile
• User : This page shows the courses the user has published and the courses he has enrolled for.
• Edit post : User can edit their recipe post
• Login-in : User can log in to their account
• Register : User can create a new account with a unique username
• Recipe post : User can enroll for a course , view the recipe and check reviews or write their own.

Entity-Relationship (ER) Diagram


Teaser (MS3)