chs73
Table of Contents
Overview
CHS73 is the frontend application for the Central High School Class of 1973 reunion website. The goal of the website is to generate anticipation among alumni, inform them about reunion news and upcoming events, and to periodically poll members for their opinions.
Application Architecture
The application consists of a web frontend (this repo) and a backend application server located in this repo.
The frontend is built using these libraries, services, and tools:
| Dependency | Description |
|---|---|
| Svelte | Frontend framework |
| Cloudinary | Photo management service |
| TailwindCSS | Utility-first CSS framework |
| Netlify | Website host |
| Paypal | Event payment processing |
The FE relies on a backend server for emailing and managing classmate & faculty data. GraphQL is used to request email services, while a traditional REST API is used for processing classmate & faculty data.
Our BE repo is located here.
Installation & Configuration
-
Clone or fork this repo using git. Don't forget that to create a runnable application you'll also need the backend.
-
npm install -
To run the app locally enter
npm run dev -
Open a new browser window and navigate to the URL
http://localhost:3000. This assumes that you haven't changed the default port number.
Environment variables
The following environment variables must be set up for the app to run properly:
| Key | Value |
|---|---|
| VITE_BE_URL | http://localhost:3100 |
| VITE_CLOUDINARY_NAME | <your 9-character unique cloud name> |
| PAYPAL_CLIENT_ID |
Testing
This app uses Playwright for end-to-end testing. Tests are maintained
in the tests directory.
To run all tests enter the command npm test. To run a specific test
use the command npx playwright test <test-file-name>. For example, npx playwright test 0201-fridayevent.spec.js.
Release History
You can find what changed, when in the release history
License
Copyright 2021, 2022
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.