@ -63,7 +63,7 @@ Dick was created to be an easy to use front end for <a href="https://github.com/
7. hCaptcha on login and register pages <ahref="https://www.hcaptcha.com/">You can learn more here</a>.
7. hCaptcha on login and register pages <ahref="https://www.hcaptcha.com/">You can learn more here</a>.
**Planned Feautres:**
**Planned Feautres:**
1. There are a lot of good ideas out there, to keep track of what is currently planned see <ahref="https://github.com/Facinorous-420/dick/projects/2">the v1.1 project board</a>
1. There are a lot of good ideas out there, to keep track of what is currently planned see <ahref="https://github.com/users/Facinorous-420/projects/2">the project board</a>
The front end is built using <ahref="https://tailwindcss.com">Tailwind CSS</a>, <ahref="https://lucide.dev/">Lucide Icons,</a> as well as hand crafted components all templated using <ahref="https://ejs.co/">EJS</a>. I plan to eventually rewrite this in React.
The front end is built using <ahref="https://tailwindcss.com">Tailwind CSS</a>, <ahref="https://lucide.dev/">Lucide Icons,</a> as well as hand crafted components all templated using <ahref="https://ejs.co/">EJS</a>. I plan to eventually rewrite this in React.
@ -83,11 +83,10 @@ Inside this file, is some basic configuration you can change for your set up. Th
| `DICK_SUBMODULE = false` | Put this to true if you wish to run DICK as an ASS submoduke, false if seperate |
| `ASS_LOCATION = "../ass"` | If running DICK seperately, DICK will use this to find your ASS install folder |
| `ASS_SECURE = false` | Put this to true if you are running ASS behind a domain with HTTPS,. false if HTTP |
| `ASS_SECURE = false` | Put this to true if you are running ASS behind a domain with HTTPS,. false if HTTP |
| `ASSDOMAIN = "127.0.0.1:40115"` | Put this to your ASS domain. Can be an ip, or domain for example `https://cdn.mydomain.com` |
| `ASSDOMAIN = "127.0.0.1:40115"` | Put this to your ASS domain. Can be an ip, or domain for example `https://cdn.mydomain.com` |
| `PORT = "3000"` | Change this number to the port you wish DICK to run on |
| `ASS_LOCATION = "../ass"` | If running DICK seperately, DICK will use this to find your ASS install folder. Leave this alone if using Docker. |
| `PORT = "3000"` | Change this number to the port you wish DICK to run on. Leave this alone if using Docker. |
> **Note**
> **Note**
> If you want to set a user as admin, currently you must do it via the database file generated at `/src/database/users.json` and change the users role from `user` to `admin`. By default, the first user to login to your dick instance will be admin.
> If you want to set a user as admin, currently you must do it via the database file generated at `/src/database/users.json` and change the users role from `user` to `admin`. By default, the first user to login to your dick instance will be admin.
@ -114,7 +113,21 @@ Inside this file, is some basic configuration you can change for your set up. Th
#### Production
#### Production
<details>
<details>
<summary>
<summary>
<sub>Open to view the production set up steps</sub>
<sub>Open to view the docker production set up steps</sub>
</summary><br/>
1. Create a folder, call it whatever you wish
2. Install, and run ASS https://github.com/tycrek/ass#installation (This will create an `ass` folder)
3. Go back into the folder you created and clone this repo `git clone https://github.com/Facinorous-420/dick.git`
4. Go into the newly created `dick` folder `cd dick`
5. Go into `/src` and copy `constants.ts.example` to `constants.ts` and edit it as needed
6. Go back to the root of `dick` and edit the `docker-compose.yml` to match your specific needs by changing the port, and voluime location where your ass files are on your system.
7. Run the docker compose file `docker-compose up -d` this will create a new container named `dick`.
</details>
<details>
<summary>
<sub>Open to view the source production set up steps</sub>
</summary><br/>
</summary><br/>
1. Create a folder, call it whatever you wish
1. Create a folder, call it whatever you wish
@ -124,7 +137,6 @@ Inside this file, is some basic configuration you can change for your set up. Th
5. Go into `/src` and copy `constants.ts.example` to `constants.ts` and edit it as needed
5. Go into `/src` and copy `constants.ts.example` to `constants.ts` and edit it as needed
6. Go back to the root of `dick` and install the dependancies for the frontend, `npm i`
6. Go back to the root of `dick` and install the dependancies for the frontend, `npm i`
7. Run `npm start` to compile the code base and run DICK
7. Run `npm start` to compile the code base and run DICK
</details>
</details>
When you approach the login screen, the login information is your ASS username, and the secret key generated by ASS is your password.
When you approach the login screen, the login information is your ASS username, and the secret key generated by ASS is your password.