Skip to content

ShyAssassin/assassin.dev

Repository files navigation

assassin.dev

Project Structure Overview

  • public/* - Static assets including fonts and images.
  • src/lib/* - A collection of helpful utilities or code for external services.
  • src/pages/* - All of the routes for the site.
  • src/pages/api/* - API Routes powering multiple parts of the site.
  • src/components/* - React components used through out the site.

Running Locally

This application requires Nodejs version 16.13+.
Port 4141 is used by default on locallhost when running dev builds.

git clone https://github.com/ShyAssassin/assassin.dev
cd assassin.dev
npm install
cp .env.example .env
npm run dev

Make sure to fill in .env with needed values.

Cloning / Forking

This project is under the MIT License.

I'm cool with anyone using the code or parts of the code for their own site or presonal project, it is open source so people can learn from it and adapt it.
However, you must follow the following conditions.

  • Do not present any of the projects from /projects as your own.
  • Do not use any art (images, models, etc) of my OC (Original Character).

Check out the LICENSE for more details.