This project is a gamification of concepts from the Networking I, II, III, & IV classes at Wayne State College.
Check out the current deployment!
This section outlines how to contribute to this project.
staging
branch.package.json
.staging
branch.This section outlines how to deploy this project.
main
branch.docker-compose.yml
file.automatic redeploy on push
option.Deploy the stack
button.staging
branch.This section outlines what concepts will be covered in this project.
...Others to come
This section outlines what this website has to at least accomplish to provide use to visitors.
Users are able to:
This section outlines what I hope to get to with this project.
This will include some resources about this project.
SvelteKit - This is the framework we're using for this project. It's a lot like React, but it's a lot easier to use.
Svelte - This is the framework that SvelteKit is built on.
Vite - This is the build tool that SvelteKit uses.
Apollo Client - This is the GraphQL client we're using for this project.
GraphQL - This is the query language we're using for this project.
Markdown Cheatsheet - This is a cheatsheet for Markdown. This is what we use to write this README and many others.
Hasura - This is the GraphQL engine we're using for this project. This takes care of the Graphql API and database.
Digital Ocean Spaces - This is the object storage we're using for this project. This is where we store the images.
This section outlines the commands I use to run this project.
nvm
This can be used to manage which version of npm is being used. This can be installed here.
nvm install 19.5.0
Run this before running any of the following commands.
nvm use 19.5.0
Run this before running any of the following commands.
node -v
Check node version, verify you're on 19.5.0
npm install
- Installs the dependencies for this project.
npm run dev
- Runs a local version of the app
This section outlines the dependencies I use for this project and the command used to install them. They should also be included in the package.json
file.
YOU DON'T NEED TO ENTER THESE COMMANDS. npm install
should install them for you.
@sveltejs/adapter-node
- Used for deploying with Node.js. Used in svelte.config.js
.
@sveltejs/kit
- Used for SvelteKit. Used in svelte.config.js
.
eslint
- Used for linting JavaScript. Pretty much checks for errors.
eslint-config-prettier
- Used for formatting Code.
eslint-plugin-svelte
- Used for linting Svelte.
prettier
- Used for formatting Code.
prettier-plugin-svelte
- Used for formatting Svelte.
svelte
- Used for Svelte.
vite
- Used for Vite.
@apollo/client
- Used for Apollo Client. To make GraphQL requests.
graphql
- Used for GraphQL statements. To make GraphQL requests.
svelte-apollo
- Used for Svelte Apollo. To make GraphQL requests.
svelte-icons-pack
- Used for Svelte Icons.
xlsx
- Used to read and write to Excel files.
dotenv
- Used for .env files.
This section outlines the extensions I use for this project. These are very helpful for web-development.
ESLint
- Used for linting JavaScript.
Prettier
- Used for formatting Code.
GitHub Copilot
- Used for code suggestions. This is a must for programmers! Can be free with a student email address here.
GitLens
- Used for git information. Makes it easier to Git blame people.
GitHub Repositories
- Used to see GitHub Repositories and their information.
Indent Rainbow
- Makes indentation easier to see.
Path Intellisense
- Gives path suggestions and autocompletion.
Code Spell Checker
- Used for spell checking.
Polacode
- Used for taking screenshots of code.
Import Cost
- Used for seeing the size of imports.
Highlight Matching Tag
- Used for highlighting matching tags.
Auto Rename Tag
- Used for renaming matching tags.
Auto Close Tag
- Used for closing matching tags.
Advanced New File
- Allows you to create new files in the current directory from the keyboard.
vscode-pets
- PETS!
WakaTime
- Used for tracking time spent on projects.
SynthWave '84
- A nice theme for VSCode.
Material Icon Theme
- Nice icons for VSCode.
Dotenv Official +Vault
- Used for .env files.
Edit csv
- Gives a table UI for CSV files.
Excel Viewer
- Gives a table UI for Excel files.
Markdown Preview GitHub Styling
- Used for Markdown files. You can use this to preview Markdown files.
markdownlint
- Used for linting Markdown files.
npm Intellisense
- Used for npm autocompletion in import statements.
Svelte for VS Code
- Used for Svelte.
Svelte 3 Snippets
- Used for Svelte.
Svelte Intellisense
- Used for Svelte.
VS Color Picker
- Used for picking colors in CSS.
Svelte Auto Import
- Used for Svelte.