repo: Merge pull request #16 from pinnacleusorg/development

v3.0

.env.staging → .env

@@ -1,4 +1,4 @@
 
 API_ROOT="https://api-staging.pinnacle.us.org/1.0"
 
-VITE_API_ROOT=$API_ROOT
+PUBLIC_API_ROOT=$API_ROOT

CONTRIBUTING.md

@@ -3,8 +3,8 @@
 ### Commit Prefixes
 This branch currently uses the following (discretionary) commit prefixes:
 - `fix:` Fix an outstanding issue (e.g. Fixed page scroll on Safari)
-- `repo:` Repository-wide or general repository-affecting changes (e.g. Update README)
-- `sp/feat:` Sapper-specific / general project additions (e.g. Added new component)
+- `repo:` Repository-wide or general repository-affecting changes (e.g. Update README or refactor)
+- `feat:` Sapper-specific / general project additions (e.g. Added new component)
 - `style:` Style-only changes. Guaranteed to not affect functionality (e.g. Changed global border colour)
 
 These are intended to make viewing git history easier, giving an overview of potentially breaking or major changes.
@@ -13,105 +13,20 @@ These are intended to make viewing git history easier, giving an overview of pot
 
 ### Running the project
 
-Once you have created the project, install dependencies and run the project in development mode:
+Once you have created the project, install dependencies and run with:
 
 ```bash
-cd my-app
 npm install # or yarn
 npm run dev
 ```
 
-This will start the development server on [localhost:3000](http://localhost:3000). Open it and click around.
+This will start the development server, with localhost URL in the terminal.
 
-You now have a fully functional Sapper project! To get started developing, consult [sapper.svelte.dev](https://sapper.svelte.dev).
+## Non-Pinnacle Staff
 
-## Directory structure
+Please report any issues you find with GitHub issues. If you're interested in helping us build and extend new attendee and event experiences, consider joining one of our engineering teams at [pinnacle.us.org/apply](https://pinnacle.us.org/apply)!
 
-Sapper expects to find two directories in the root of your project —  `src` and `static`.
+## SvelteKit
 
+Please refer to the [latest SvelteKit documentation](https://kit.svelte.dev) for more information.
 
-### src
-
-The [src](src) directory contains the entry points for your app — `client.js`, `server.js` and (optionally) a `service-worker.js` — along with a `template.html` file and a `routes` directory.
-
-
-#### src/routes
-
-This is the heart of your Sapper app. There are two kinds of routes — *pages*, and *server routes*.
-
-**Pages** are Svelte components written in `.svelte` files. When a user first visits the application, they will be served a server-rendered version of the route in question, plus some JavaScript that 'hydrates' the page and initialises a client-side router. From that point forward, navigating to other pages is handled entirely on the client for a fast, app-like feel. (Sapper will preload and cache the code for these subsequent pages, so that navigation is instantaneous.)
-
-**Server routes** are modules written in `.js` files, that export functions corresponding to HTTP methods. Each function receives Express `request` and `response` objects as arguments, plus a `next` function. This is useful for creating a JSON API, for example.
-
-There are three simple rules for naming the files that define your routes:
-
-* A file called `src/routes/about.svelte` corresponds to the `/about` route. A file called `src/routes/blog/[slug].svelte` corresponds to the `/blog/:slug` route, in which case `params.slug` is available to the route
-* The file `src/routes/index.svelte` (or `src/routes/index.js`) corresponds to the root of your app. `src/routes/about/index.svelte` is treated the same as `src/routes/about.svelte`.
-* Files and directories with a leading underscore do *not* create routes. This allows you to colocate helper modules and components with the routes that depend on them — for example you could have a file called `src/routes/_helpers/datetime.js` and it would *not* create a `/_helpers/datetime` route.
-
-
-#### src/node_modules/images
-
-Images added to `src/node_modules/images` can be imported into your code using `import 'images/<filename>'`. They will be given a dynamically generated filename containing a hash, allowing for efficient caching and serving the images on a CDN.
-
-See [`index.svelte`](src/routes/index.svelte) for an example.
-
-
-#### src/node_modules/@sapper
-
-This directory is managed by Sapper and generated when building. It contains all the code you import from `@sapper` modules.
-
-
-### static
-
-The [static](static) directory contains static assets that should be served publicly. Files in this directory will be available directly under the root URL, e.g. an `image.jpg` will be available as `/image.jpg`.
-
-The default [service-worker.js](src/service-worker.js) will preload and cache these files, by retrieving a list of `files` from the generated manifest:
-
-```js
-import { files } from '@sapper/service-worker';
-```
-
-If you have static files you do not want to cache, you should exclude them from this list after importing it (and before passing it to `cache.addAll`).
-
-Static files are served using [sirv](https://github.com/lukeed/sirv).
-
-
-## Bundler configuration
-
-Sapper uses Rollup or webpack to provide code-splitting and dynamic imports, as well as compiling your Svelte components. With webpack, it also provides hot module reloading. As long as you don't do anything daft, you can edit the configuration files to add whatever plugins you'd like.
-
-
-## Production mode and deployment
-
-To start a production version of your app, run `npm run build && npm start`. This will disable live reloading, and activate the appropriate bundler plugins.
-
-You can deploy your application to any environment that supports Node 10 or above. As an example, to deploy to [Vercel Now](https://vercel.com) when using `sapper export`, run these commands:
-
-```bash
-npm install -g vercel
-vercel
-```
-
-If your app can't be exported to a static site, you can use the [vercel-sapper](https://github.com/thgh/vercel-sapper) builder. You can find instructions on how to do so in its [README](https://github.com/thgh/vercel-sapper#basic-usage).
-
-
-## Using external components
-
-When using Svelte components installed from npm, such as [@sveltejs/svelte-virtual-list](https://github.com/sveltejs/svelte-virtual-list), Svelte needs the original component source (rather than any precompiled JavaScript that ships with the component). This allows the component to be rendered server-side, and also keeps your client-side app smaller.
-
-Because of that, it's essential that the bundler doesn't treat the package as an *external dependency*. You can either modify the `external` option under `server` in [rollup.config.js](rollup.config.js) or the `externals` option in [webpack.config.js](webpack.config.js), or simply install the package to `devDependencies` rather than `dependencies`, which will cause it to get bundled (and therefore compiled) with your app:
-
-```bash
-npm install -D @sveltejs/svelte-virtual-list
-```
-
-## Troubleshooting
-
-Using Windows and WSL2?
-
-If your project lives outside the WSL root directory, [this limitation](https://github.com/microsoft/WSL/issues/4169) is known to cause live-reloading to fail. See [this issue](https://github.com/sveltejs/sapper/issues/1150) for details.
-
-## Bugs and feedback
-
-Sapper is in early development, and may have the odd rough edge here and there. Please be vocal over on the [Sapper issue tracker](https://github.com/sveltejs/sapper/issues).

Dockerfile

@@ -11,6 +11,7 @@ FROM builder as staging
 ENV PORT=9000
 ENV NODE_ENV="staging"
 ENV LOCAL_ROOT="https://staging.pinnacle.us.org"
+ENV PUBLIC_API_ROOT="https://api-staging.pinnacle.us.org/1.0"
 RUN npm run build
 EXPOSE 9000
 CMD [ "node", "./build/index.js" ]
@@ -19,6 +20,7 @@ FROM builder as production
 ENV PORT=9001
 ENV NODE_ENV="production"
 ENV LOCAL_ROOT="https://pinnacle.us.org"
+ENV PUBLIC_API_ROOT="https://api.pinnacle.us.org/1.0"
 RUN npm run build
 EXPOSE 9001
 CMD [ "node", "./build/index.js" ]

README.md

@@ -1,6 +1,6 @@
 # Pinnacle Landing
 
-[![https://maintained.cc/SDBagel/pinnacle.us.org/2](https://maintained.cc/SDBagel/pinnacle.us.org/2)](https://maintained.cc/SDBagel/pinnacle.us.org/2/redirect)
+![https://tai.maintained.cc/ivynya/Pinnacle/1](https://tai.maintained.cc/ivynya/Pinnacle/1)
 
 ## Running in Development
 
@@ -11,4 +11,4 @@ npm run dev
 
 ## Contributing
 
-For a full contributing guide as well as more details on how to work with Sapper, see `CONTRIBUTING.md`.
+Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md).