Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exu3/connect
🌐 Command Connect is a mentorship program for female and non-binary students interested in STEM.
https://github.com/exu3/connect
svelte
Last synced: 12 days ago
JSON representation
🌐 Command Connect is a mentorship program for female and non-binary students interested in STEM.
- Host: GitHub
- URL: https://github.com/exu3/connect
- Owner: exu3
- Created: 2021-03-25T02:31:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-29T04:21:00.000Z (almost 3 years ago)
- Last Synced: 2023-03-05T19:38:12.413Z (over 1 year ago)
- Topics: svelte
- Language: JavaScript
- Homepage: https://connect.commandtech.dev
- Size: 32.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Command Connect
This is a Svelte app.
## Get started
First, clone the repo:
```bash
git clone https://github.com/eilla1/connect.git
```
Install the dependencies...
> *Note that you will need to have [Node.js](https://nodejs.org) installed.*
```bash
cd connect
npm install
```
...then start [Rollup](https://rollupjs.org):
```bash
npm run dev
```
Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
If you're using [Visual Studio Code](https://code.visualstudio.com/) install the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.
## Building and running in production mode
To create an optimised version of the app:
```bash
npm run build
```
You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).
## Single-page app mode
By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for *any* path. You can make it so by editing the `"start"` command in package.json:
```js
"start": "sirv public --single"
```
## Using TypeScript
This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
```bash
node scripts/setupTypeScript.js
```
Or remove the script via:
```bash
rm scripts/setupTypeScript.js
```
If you want to use `baseUrl` or `path` aliases within your `tsconfig`, you need to set up `@rollup/plugin-alias` to tell Rollup to resolve the aliases. For more info, see [this StackOverflow question](https://stackoverflow.com/questions/63427935/setup-tsconfig-path-in-svelte).
## Deploying to the web
### With [Vercel](https://vercel.com)
Install `vercel` if you haven't already:
```bash
npm install -g vercel
```
Then, from within your project folder:
```bash
cd public
vercel deploy --name my-project
```