https://github.com/zwldarren/inf133_project
https://github.com/zwldarren/inf133_project
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zwldarren/inf133_project
- Owner: zwldarren
- Created: 2024-11-23T07:09:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-05T02:53:59.000Z (over 1 year ago)
- Last Synced: 2025-02-05T03:26:59.221Z (over 1 year ago)
- Language: Vue
- Size: 262 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# INF133 Project
## Table of Contents
- [Introduction](#introduction)
- [Installation and Running](#installation-and-running)
- [Scripts](#scripts)
## Introduction
It's a collection of calendars, notes and AI web apps. The project is based on Vuetify + Javascript.
## Installation and Running
### Prerequisites
Ensure Node.js and npm are installed on your system. You can download them from the [Node.js official website](https://nodejs.org/).
### Clone the Repository
```bash
git clone https://github.com/zwldarren/INF133_project.git
cd INF133_project
```
### Install Dependencies
Run the following command to install both frontend and backend dependencies:
```bash
npm install
```
### Environment Variables
#### Backend
The backend requires certain environment variables to run. You should create a `.env` file in the `backend` directory based on the provided `.env.template`.
```bash
cp backend/.env.template backend/.env
```
Note: You need to edit the `.env` file with your OpenAI API key. You should have the OpenAI API key for the backend to function.
### Start the Project
Run the following command to start both the frontend and backend servers concurrently:
```bash
npm run start
```
## Scripts
- `npm run dev` - Start the frontend development server.
- `npm run build` - Build the frontend project for production.
- `npm run preview` - Preview the production build.
- `npm run lint` - Run ESLint to fix code issues.
- `npm run start` - Start both frontend and backend concurrently.