Blake's Mods Website

This repository contains the source code of blakesmods.com.

Contributing

If you would like to contribute content to the Documentation or Wiki, you can do so by editing the files in the apps/web/content directory.

While you can do simple edits using the GitHub UI, it's recommended to set up a development environment so that you can preview how the content will look on the website itself while writing it. (see Development)

Notes relating to writing content:

• assets (such as images) are placed in the apps/web/public/assets directory and can be linked to in your markdown by using the /assets/<asset path> url
• components placed in the apps/web/components/global directory are usable in your markdown

Development

To get a local development environment set up, you can do the following:

1. run yarn to install all required dependencies
2. run yarn dev to start the dev servers
   1. if you are contributing content, you can run yarn dev --filter web to run just the website
   2. to run a local database, run docker compose up
   3. to seed your local database with data, run yarn workspace @blakesmods/db seed

License

MIT License