Skip to content

Commit

Permalink
updated readme with simple explanation of site
Browse files Browse the repository at this point in the history
  • Loading branch information
harvanchik committed Jan 20, 2023
1 parent 14e5fe5 commit 9cff78a
Showing 1 changed file with 4 additions and 35 deletions.
39 changes: 4 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,7 @@
# create-svelte
# The Case Play App

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
This web application houses sports case plays that are used for educational purposes.

## Creating a project
## Finding a Case Play

If you're seeing this, you've probably already done this step. Congrats!

```bash
# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app
```

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

```bash
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open
```

## Building

To create a production version of your app:

```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.
As of right now, there is a home page that lists all of the case plays loaded in the database. You can find this home page at https://caseplay.org. From there, you can click the `copy url` button to share the case play with others.

1 comment on commit 9cff78a

@vercel
Copy link

@vercel vercel bot commented on 9cff78a Jan 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

case-play – ./

case-play-git-main-harvanchik.vercel.app
case-play-harvanchik.vercel.app
caseplay.org
www.caseplay.org

Please sign in to comment.