Skip to content

Commit

Permalink
Merge branch 'update-readme' into fix-desktop
Browse files Browse the repository at this point in the history
  • Loading branch information
JHWelch committed Dec 30, 2023
2 parents 1a2342d + 905c518 commit c50c939
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,6 @@

An integration with [Notion](https://notion.so) to display weekly movie nights using a Notion database as the source of truth.

## Deploy to App Engine

This app is deployed to Google App Engine. It will automatically deploy on all merges to `main.` This is the preferred method of deployment.

App engine will build the application with `npm run build` and serve the application with `npm run start`.

Manual deployments can be performed with the built in script.

You must first have a copy of `.env.production` in the root directory. Then run:

```sh
sh scripts/deploy.sh
```

## Development

### .env
Expand All @@ -40,10 +26,35 @@ npm run dev

```sh
npm run lint
```

```sh
npm run fix
```

### Repository Structure

This application is split into two parts:

- `server` - The Express server that serves the application and handles API requests.
- `client` - The Vue application served by the Express server that handles the UI.

Each part has its own `package.json` and `node_modules` directory, however both can be installed with a single `npm install` command.

## Deploy to App Engine

This app is deployed to Google App Engine. It will automatically deploy on all merges to `main.` This is the preferred method of deployment.

App engine will build the application with `npm run build` and serve the application with `npm run start`.

Manual deployments can be performed with the built in script.

You must first have a copy of `.env.production` in the root directory. Then run:

```sh
sh scripts/deploy.sh
```

## Technologies

- [EJS](https://ejs.co/)
Expand Down

0 comments on commit c50c939

Please sign in to comment.