lilyliu0719/cs278-mealmate

final project of CS278 at 2024 Spring

MealMate

Welcome to MealMate! This repository contains the source code for a meal planning application.

How to Run the Code

To run the code locally, follow these steps:

1. Make sure you have the following prerequisites installed on your machine:

   • Git: Download Git
   • Node.js: Download Node.js, version 14.8 or later
   • npm or yarn: Install either npm or yarn. You can find installation instructions for npm here and for yarn here
   • An SSH key added to your GitHub account. You can find instructions here

2. Open your terminal and navigate to the directory where you want to store the repository.

3. Clone the repository by running the following command:

   git clone [email protected]:LilyLiu0719/CS278-mealmate.git
   cd CS278-mealmate
   npm install
   

4. Install the repository's dependencies:

   npm install -g @wix/cli
   

5. Run the code in development mode:

   wix dev
   

Major Functions

The src directory contains the following major functions:

• pages/masterPage.js: This is our site's global code, will run on every pages.
  • pages/Forum: This program will run when the forum page is loaded.
  • pages/Profile: This program will run when the profile page is loadede.
  • pages/Search Results: This program will run when the settings page is loaded.
• backend/: this folder contains some regular backend JavaScript files that define the feature functions
  • event.js: Handle event that will be triggered automatically
  • checkPost.js: This program will run when a post is checked for validity.
  • chat.js: Handle DM
  • toxicity.js: Preform moderation
• public/: Public code that can be accessed by your frontend and backend code.
  • helper.js: helper functions that handle filtering and ranking

Git Integration & Wix CLI

This repo is part of Git Integration & Wix CLI, a set of tools that allows you to write, test, and publish code for your Wix site locally on your computer.

Connect your site to GitHub, develop in your favorite IDE, test your code in real time, and publish your site from the command line.

Set up this repository in your IDE

This repo is connected to a Wix site. That site tracks this repo's default branch. Any code committed and pushed to that branch from your local IDE appears on the site.

Before getting started, make sure you have the following things installed:

• Git
• Node, version 14.8 or later.
• npm or yarn
• An SSH key added to your GitHub account.

To set up your local environment and start coding locally, do the following:

1. Open your terminal and navigate to where you want to store the repo.
2. Clone the repo by running git clone <your-repository-url>.
3. Navigate to the repo's directory by running cd <directory-name>.
4. Install the repo's dependencies by running npm install or yarn install.
5. Install the Wix CLI by running npm install -g @wix/cli or yarn global add @wix/cli.
   Once you've installed the CLI globally, you can use it with any Wix site's repo.

For more information, see Setting up Git Integration & Wix CLI.

Write Velo code in your IDE

Once your repo is set up, you can write code in it as you would in any other non-Wix project. The repo's file structure matches the public, backend, and page code sections in Editor X.

Learn more about this repo's file structure.

Test your code with the Local Editor

The Local Editor allows you test changes made to your site in real time. The code in your local IDE is synced with the Local Editor, so you can test your changes before committing them to your repo. You can also change the site design in the Local Editor and sync it with your IDE.

Start the Local Editor by navigating to this repo's directory in your terminal and running wix dev.

For more information, see Working with the Local Editor.

Preview and publish with the Wix CLI

The Wix CLI is a tool that allows you to work with your site locally from your computer's terminal. You can use it to build a preview version of your site and publish it. You can also use the CLI to install approved npm packages to your site.

Learn more about working with the Wix CLI.

Invite contributors to work with you

Git Integration & Wix CLI extends Editor X's concurrent editing capabilities. Invite other developers as collaborators on your site and your GitHub repo. Multiple developers can work on a site's code at once.