Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md and start of improvements #436

Merged
merged 14 commits into from
Feb 26, 2024
Merged
40 changes: 14 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,26 @@
# create-svelte
# FluCoMa Learn

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
This is the code for the [FluCoMa Learn Website](https://learn.flucoma.org).

## Creating a project
## Working Locally

If you're seeing this, you've probably already done this step. Congrats!
To work locally you will need `node` (> 16.6.0 && <= 19.9.0>) installed on your computer as well as either `npm` or `pnpm`.

```bash
# create a new project in the current directory
npm create svelte@latest
### 1. Installing Dependencies

# create a new project in my-app
npm create svelte@latest my-app
```
Set your current working directory to this repository with `cd`. Once you are there in your terminal, install all dependencies with:

## Developing
`npm i`.

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
> [!TIP]
> Replace `npm` with your package manager of choice. At this time, `bun` isn't really supported.

```bash
npm run dev
### 2. Starting the Development Server

# or start the server and open the app in a new browser tab
npm run dev -- --open
```
Once you have the necessary dependencies. Start the development server by running `npm run dev`. A local development server should be started on port `5173`. You can navigate to https://localhost:5173 to see the site in realtime.

## Building
From here, make your changes and see them live in the browser!

To create a production version of your app:
## Contributing

```bash
npm run build
```

You can preview the production build with `npm run preview`.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
Contributions are most welcome from the communuity. Please make a branch, add your changes then submit a pull request!
49 changes: 25 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,54 +14,55 @@
"format": "prettier --plugin-search-dir . --write ."
},
"devDependencies": {
"@sveltejs/adapter-static": "^2.0.1",
"@sveltejs/kit": "^1.14.0",
"eslint": "^8.36.0",
"eslint-config-prettier": "^8.8.0",
"@sveltejs/adapter-static": "^3.0.1",
"@sveltejs/kit": "^2.5.1",
"@sveltejs/vite-plugin-svelte": "^3.0.2",
"eslint": "^8.57.0",
"eslint-config-prettier": "^8.10.0",
"eslint-plugin-svelte3": "^4.0.0",
"front-matter": "^4.0.2",
"github-slugger": "^2.0.0",
"hastscript": "^7.2.0",
"markdown": "^0.5.0",
"markdown-link-extractor": "^3.1.0",
"mdsvex": "^0.10.6",
"node-fetch": "^3.3.1",
"prettier": "^2.8.7",
"prettier-plugin-svelte": "^2.10.0",
"node-fetch": "^3.3.2",
"prettier": "^2.8.8",
"prettier-plugin-svelte": "^2.10.1",
"rehype-autolink-headings": "^6.1.1",
"rehype-slug": "^5.1.0",
"svelte": "^3.57.0",
"svelte-check": "^3.1.4",
"svelte-preprocess": "^5.0.3",
"tap-mocha-reporter": "^5.0.3",
"vite": "^4.2.1",
"vitest": "^0.29.7"
"svelte": "^4.2.12",
"svelte-check": "^3.6.4",
"svelte-preprocess": "^5.1.3",
"tap-mocha-reporter": "^5.0.4",
"vite": "^5.1.4",
"vitest": "^1.3.1"
},
"type": "module",
"dependencies": {
"@flucoma/tf-kmeans": "^0.0.3",
"@juggle/resize-observer": "^3.4.0",
"@tensorflow/tfjs": "^4.2.0",
"@tensorflow/tfjs": "^4.17.0",
"array-smooth": "^1.0.0",
"chart.js": "^3.1.0",
"chartjs-plugin-annotation": "^1.4.0",
"d3": "^7.8.3",
"fast-glob": "^3.2.12",
"chart.js": "^4.0.0",
"chartjs-plugin-annotation": "^3.0.1",
"d3": "^7.8.5",
"fast-glob": "^3.3.2",
"fuse.js": "^6.6.2",
"fuzzy-search": "^3.2.1",
"konva": "^8.4.3",
"lodash": "^4.17.21",
"meyda": "^5.6.0",
"meyda": "^5.6.2",
"numpy-parser": "^1.2.3",
"peaks.js": "^2.1.0",
"pts": "^0.11.3",
"pts": "^0.11.5",
"seedrandom": "^3.0.5",
"svelte-bricks": "^0.1.7",
"svelte-select": "^5.5.2",
"svelte-select": "^5.8.3",
"svelte-youtube": "^0.0.2",
"tone": "^14.7.77",
"two.js": "^0.8.10",
"two.js": "^0.8.13",
"umap-js": "^1.3.3",
"waveform-data": "^4.3.0"
"waveform-data": "^4.5.0"
}
}
}
Loading
Loading