neroshitron/README.md

33 lines
1.5 KiB
Markdown
Raw Normal View History

2024-05-21 22:33:07 -04:00
# Neroshitron
2024-05-23 20:58:51 -04:00
![image](https://github.com/D4M13N-D3V/neroshitron/assets/13697702/87db1132-2191-425f-adfb-bde5601aea96)
![image](https://github.com/D4M13N-D3V/neroshitron/assets/13697702/583e1ddd-8304-4da1-a2f8-3492920b3cf7)
2024-05-23 20:58:04 -04:00
2024-05-23 20:57:10 -04:00
2024-05-21 22:32:11 -04:00
## Development
2024-05-21 23:10:17 -04:00
### Documentation For Initial Project Setup
2024-05-21 23:06:08 -04:00
- https://nextjs.org/docs
2024-05-23 20:59:21 -04:00
- https://appwrite.io/docs
2024-05-21 23:53:45 -04:00
### Running With Docker
1) Open your terminal and navigate to the root of the git repository.
2) Make sure that docker and docker compose are installed.
3) Run `docker-compose --env-file ./docker.env up` which will start up OwnCast, AppWrite, and the UI.
2024-05-21 23:57:39 -04:00
#### OwnCast
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.
#### AppWrite
http://localhost:80/
2024-05-22 00:01:08 -04:00
You will need to register and sign up, the first account on the appwrite instance will be the admin account.ç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-21 23:57:39 -04:00
#### UI
http://localhost:3000
2024-05-21 23:53:45 -04:00
### Running Without Docker
2024-05-21 22:46:32 -04:00
1) Open your terminal and navigate to the root folder of the git repository.
2) Run the command `npm update`.
3) Once the depedencies are pulled and installed you can run the command `npm run dev` to run the application in development mode.
2024-05-21 22:46:48 -04:00
4) Open http://localhost:3000/