diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f4fa80a --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,18 @@ + +MIT License +Copyright (c) 2020 Zev Averbach +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 234b074..9ed14d1 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,7 @@ -*Looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)* +# Binary Quiz Front End ---- +This is a Svelte app that makes binary math quizzes. -# svelte app - -This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template. - -To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit): - -```bash -npx degit sveltejs/template svelte-app -cd svelte-app -``` - -*Note that you will need to have [Node.js](https://nodejs.org) installed.* - - -## Get started - -Install the dependencies... - -```bash -cd svelte-app -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`. - - -## 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" -``` - - -## Deploying to the web - -### With [now](https://zeit.co/now) - -Install `now` if you haven't already: - -```bash -npm install -g now -``` - -Then, from within your project folder: - -```bash -cd public -now deploy --name my-project -``` - -As an alternative, use the [Now desktop client](https://zeit.co/download) and simply drag the unzipped project folder to the taskbar icon. - -### With [surge](https://surge.sh/) - -Install `surge` if you haven't already: - -```bash -npm install -g surge -``` - -Then, from within your project folder: - -```bash -npm run build -surge public my-project.surge.sh -``` +## Dependencies +- [svelte](https://svelte.dev) +- [Binary Quiz Back End](https://github.com/zevaverbach/binary_quiz_backend) diff --git a/package-lock.json b/package-lock.json index f5a191a..3302d9c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,7 @@ { - "name": "svelte-app", - "version": "1.0.0", + "name": "binary-quiz-frontend", + "version": "0.0.1", + "license": "MIT", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 9a487a6..ff58d09 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,7 @@ { - "name": "svelte-app", - "version": "1.0.0", + "name": "binary-quiz-frontend", + "version": "0.0.1", + "license": "MIT", "scripts": { "build": "rollup -c", "dev": "rollup -c -w",