neroshitron/README.md

55 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2024-05-21 22:33:07 -04:00
# Neroshitron
2024-05-24 00:20:39 -04:00
![image](https://github.com/D4M13N-D3V/neroshitron/assets/13697702/e4a9e11b-0e52-42e0-ad9a-821a81e92e90)
2024-05-26 20:23:58 -04:00
![image](https://github.com/D4M13N-D3V/neroshitron/assets/13697702/78e009be-caa0-4ae6-9c06-90dde2ab4389)
2024-05-21 22:32:11 -04:00
2024-05-26 13:10:45 -04:00
# Documentation For Technical Stack
2024-05-21 23:06:08 -04:00
- https://nextjs.org/docs
2024-05-27 09:41:33 -04:00
- https://supabase.com/docs/
- https://owncast.online/docs/
2024-05-26 20:22:11 -04:00
- https://docs.docker.com/engine/install/
2024-05-24 00:22:11 -04:00
2024-05-26 13:10:20 -04:00
# Running Backend
2024-05-27 09:41:33 -04:00
You will need docker installed.
- https://docs.docker.com/engine/install/
You will need supabase CLI.
- https://docs.docker.com/engine/install/
You need npm and nodejs installed. See documentation at start of document.
- https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
2024-05-21 23:53:45 -04:00
1) Open your terminal and navigate to the root of the git repository.
2) Make sure that docker and docker compose are installed.
2024-05-27 09:52:26 -04:00
3) Run `docker-compose --env-file ./docker.env up` which will start up OwnCast.
2024-05-27 09:41:33 -04:00
4) Run `supabase start`
5) Open your terminal and navigate to the root folder of the git repository.
6) Run the command `npm update`.
7) Once the depedencies are pulled and installed you can run the command `npm run dev` to run the application in development mode.
8) Open http://localhost:3000/
2024-05-27 09:41:33 -04:00
2024-05-27 11:29:29 -04:00
### Updating the database/Seeding data
2024-05-27 09:41:33 -04:00
Run `supabase db reset`. This will wipe data.
https://supabase.com/docs/guides/cli/local-development?queryGroups=access-method&access-method=kong#database-migrations
2024-05-27 11:29:29 -04:00
** Once the data is seeded you will need to go to the galleries bucket and add images to the folders that exist in it for the seeded galleries. **
2024-05-27 09:52:26 -04:00
## inbucket
http://localhost:54324su/monitor
2024-05-24 17:57:03 -04:00
This is where all mail being sent shows up from the application for developers.
2024-05-26 13:10:20 -04:00
## OwnCast
2024-05-21 23:57:39 -04:00
http://localhost:8080/
Configuration is done through the Owncast administration page located on your server under /admin. The login username is admin and the password is your stream key, the default being abc123.
2024-05-27 20:02:22 -04:00
# User Flow Diagram
![image](https://github.com/D4M13N-D3V/neroshitron/assets/13697702/57379445-8bd5-4a7e-8a15-7fa0b3ae42dc)
2024-05-27 09:41:33 -04:00
2024-05-27 20:02:22 -04:00
# Database Diagram
2024-06-04 00:25:36 -04:00
![image](https://github.com/D4M13N-D3V/neroshitron/assets/13697702/b3387b77-d8c6-41c4-9fe8-d52dadb6bc5e)
2024-06-04 00:24:08 -04:00
2024-06-04 00:23:21 -04:00