Backend and Frontend Template

Latest version: https://git.ita.chalmers.se/courses/dit341/group-00-web (public Github mirror)

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)
  • DIT341 course group: https://git.ita.chalmers.se/courses/dit341
  • 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.ita.chalmers.se/profile/keys
    • Make sure the email you use to commit is registered under https://git.ita.chalmers.se/profile/emails
  • Checkout the Backend-Frontend template git clone git@git.ita.chalmers.se:courses/dit341/group-00-web.git
• Server Requirements
• Client Requirements

Getting started

# Clone repository
git clone git@git.ita.chalmers.se:courses/dit341/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

Knit Happens is a project planner for knitting projects where the users get to add and see information about their projects. It is a tool for organizing and keeping track of what has been done on projects, together with what materials they want to use. Users have all the tools to create, update, or delete projects and materials. There is also a community feature where they can see what other users of Knit Happens are creating.

Pages

• Log in page: the page you land on when first visiting the website. Here the user can either log in to an existing account or create a new one.
• Homepage: displays a welcome message and provides an easy way for the logged in user to access their projects or go to their account page.
• Account page: this is where the user can change their password and if they are an admin, delete all users.
• Projects page: displays all the user's projects and also features the option to create a new project.
• Selected project page: the page a user lands on when having selected a project from the 'Projects' page. Here the user can add yarns and needles to their project, as well as update the existing information about the project such as name, date, status, priority, and notes.
• Explore page: this is where all users of Knit Happens are displayed together with their projects so all users can see what the community has been up to.
• About page: a page with information about the group behind Knit Happens.
• Log out page: this is the page where the user can log out from their account.

Entity-Relationship (ER) Diagram

Teaser (MS3)