You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-13Lines changed: 18 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,12 +68,12 @@ To install and set up the basic project, follow these steps:
68
68
69
69
1. Clone the repository to your local machine.
70
70
2. Navigate to the project directory in your terminal.
71
-
3. Install the required dependencies by running `yarn install`.
71
+
3. Install the required dependencies by running `bun install`.
72
72
4. Rename `.env.example` to simply `.env` in the project root directory and change the following lines:
73
73
-[ ]`OMDB_API_KEY=your_api_key_here` - replace `your_api_key_here` with your actual OMDB API key.
74
74
-[ ]`API_PORT=3000` - replace `3000` with the port you want the node server to run on.
75
75
-[ ]`APP_URL=binger.uk` - replace `binger.uk` with your website/app's live URL.
76
-
5. Start the application by running `yarn start`.
76
+
5. Start the application by running `bun start`.
77
77
78
78
### Nginx and Systemd Server Setup
79
79
@@ -98,8 +98,8 @@ To get the authentication and user functionality working, make sure you've follo
98
98
Application and then follow these steps.
99
99
100
100
1. Install and configure MongoDB. There are detailed instructions here:
101
-
-[Install for Debian Bookworm](./docs/mongodb/INSTALL_DEBIAN.md) found at `./docs/mongodb/INSTALL_DEBIAN.md`
102
-
-[Install for Ubuntu 20.04](./docs/mongodb/INSTALL_UBUNTU.md) found at `./docs/mongodb/INSTALL_UBUNTU.md` - note
101
+
-[Install for Debian Bookworm][install-bookworm] found at `./docs/mongodb/INSTALL_DEBIAN.md`
102
+
-[Install for Ubuntu 20.04][install-ubuntu] found at `./docs/mongodb/INSTALL_UBUNTU.md` - note
103
103
that these instructions come from ChatGPT and I haven't tested them.
104
104
I have a Debian server so please correct the instructions if you find any are incorrect and submit a PR.
105
105
@@ -127,15 +127,15 @@ Application and then follow these steps.
127
127
3. You need to run the MongoDB migrations once you've added your MongoDB details to your `.env` file.
128
128
Open up a terminal and in the project root run the following:
129
129
```bash
130
-
yarn db:migrate
130
+
bun db:migrate
131
131
```
132
132
Or if you are using NPM:
133
133
```bash
134
134
npm run db:migrate
135
135
```
136
136
137
137
4. With the MongoDB collection now migrated, you can begin using your app. Simply restart your node server so your
138
-
latest configs are loaded. If you've used the [systemd service file](./system/systemd/binger.service) I've supplied
138
+
latest configs are loaded. If you've used the [systemd service file][service] I've supplied
139
139
at `./system/systemd/binger.service` then all you need to do is restart the service with:
140
140
```bash
141
141
sudo systemctl restart binger.service
@@ -148,21 +148,21 @@ Application and then follow these steps.
148
148
149
149
[![code coverage][codecov-ice]][codecov-lnk]
150
150
151
-
- Run `yarn test` to execute the test suite.
152
-
- Run `yarn test:coverage` to generate coverage for the entire project. A summary will be printed to the console and full reports will be written to the `coverage/` folder (HTML, lcov, text).
151
+
- Run `bun run test` to execute the test suite.
152
+
- Run `bun test:coverage` to generate coverage for the entire project. A summary will be printed to the console and full reports will be written to the `coverage/` folder (HTML, lcov, text).
153
153
154
154
## Linting
155
155
156
-
- Run `yarn lint` to type-check all TypeScript files using the TypeScript compiler in no-emit mode and lint EJS templates.
157
-
- Run `yarn lint:ts` to type-check only the TypeScript files.
158
-
- Run `yarn lint:ejs` to lint EJS templates.
156
+
- Run `bun lint` to type-check all TypeScript files using the TypeScript compiler in no-emit mode and lint EJS templates.
157
+
- Run `bun lint:ts` to type-check only the TypeScript files.
158
+
- Run `bun lint:ejs` to lint EJS templates.
159
159
160
160
## OMDb API
161
161
162
-
Included in this repository is a [RapidAPI](https://rapidapi.com) file created by the macOS app RapidAPI which is free.
162
+
Included in this repository is a [RapidAPI][rapidapi] file created by the macOS app RapidAPI which is free.
163
163
There is also a VSCode extension which should be able to work with this file but YMMV.
164
164
165
-
The file is located at [/docs/api/OMDb_API.paw](/docs/api/OMDb_API.paw) and contains a working implementation of the
165
+
The file is located at [/docs/api/OMDb_API.paw][pawapi] and contains a working implementation of the
166
166
OMDb API used in this project. Open the file and begin testing the API to see responses.
167
167
168
168
## Known Issues
@@ -223,3 +223,8 @@ I want a way to kill this because there's known malware in these popups!
0 commit comments