Skip to content

Commit

Permalink
Update version && README
Browse files Browse the repository at this point in the history
  • Loading branch information
renyuneyun committed Jul 23, 2023
1 parent d557e36 commit ad86f1d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 6,976 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
# 🍜 KNoodle

KNoodle is KNoWS' (and OxfordHCC's) Solid-based alternative to Doodle It allows you to find time slots that work for different people,
KNoodle is KNoWS' (and OxfordHCC's) Solid-based alternative to Doodle. It allows you to find time slots that work for different people,
by using their availability calendar which is made available through a Solid pod.

The configuration and automatic syncing of calendar is handled by the [orchestrator](https://github.com/oxfordhcc/calendar-orchestrator). You may want to read its documentation if new here.

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Local development

You may need to initialise the application first, and then start the development server.

### Install dependencies
### Clone project and submodules

```
npm i
git clone --recurse-submodules https://github.com/OxfordHCC/knoodle.git
```

### Initialisation
This command will clone the project and download the submodules automatically.
If you have already cloned the project **but do not** have the submodules, run `git submodule update --init --recursive`.

### Install dependencies

```
npx prisma generate
npm i
```

### Run development server

```bash
npm run dev
# or
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "knoodle-react",
"version": "0.1.0",
"version": "0.2.0",
"private": true,
"scripts": {
"dev": "next dev",
Expand Down
Loading

0 comments on commit ad86f1d

Please sign in to comment.