Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nidrux/bookmark
Bookmark bot
https://github.com/nidrux/bookmark
Last synced: 10 days ago
JSON representation
Bookmark bot
- Host: GitHub
- URL: https://github.com/nidrux/bookmark
- Owner: Nidrux
- Created: 2022-06-05T10:36:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T15:34:13.000Z (12 months ago)
- Last Synced: 2024-01-05T16:00:55.083Z (11 months ago)
- Language: JavaScript
- Size: 143 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bookmark
Docker:
Step 1: Pull the repo and cd into it.
```bash
git pull https://github.com/Nidrux/Bookmark.git && cd Bookmark
```
Step 2: Build the containers and run them in detached mode.
```bash
docker-compose up -d
```
Optional:
```bash
# View active containers
docker-compose ps
# View logs of the whole docker network:
docker-compose logs -t -f
# View logs of a specific container:
docker logs -t -f CONTAINER_NAME
```
### Enviroment variables:
Enviroment variables are in the docker-compose.yml file.
**Preview:**
```yaml
services:
bookmark:
environment:
TOKEN:
STATUS: DEVELOPMENT
GUILD_ID: 973562496763953200
MONGODB_URI: mongodb://admin:root@mongodb:27017/bookmark?authSource=admin
mongodb:
environment:
# Credentials bellow are used to login to the database,
# if you change these make sure to also update the link up above
# (mongodb://admin:root@mongodb:27017/bookmark?authSource=admin)
MONGO_INITDB_ROOT_USERNAME: admin
MONGO_INITDB_ROOT_PASSWORD: root
MONGO_INITDB_DATABASE: bookmark
```
Node.js via command line
**Make sure you have Node.js installed on your machine before continuing!
Installation guid can be found [here](https://nodejs.org/en/download/)**
**Make sure you have mongoDB installed on your machine before continuing!
Installation guid can be found [here](https://www.mongodb.com/docs/manual/administration/install-community/)**
Step 1: Pull the repo and cd into it.
```bash
git pull https://github.com/Nidrux/Bookmark.git && cd Bookmark/app
```
Step 2: Install the dependencies needed and start up the bot.
```bash
npm install
```
Step 3: create an enviroment file for the bot
```bash
# linux
cd src && touch .env && echo -e "TOKEN=\nSTATUS=DEVELOPMENT\nUILD_ID=973562496763953200\nMONGODB_URI=mongodb://admin:root@localhost:27017/bookmark?authSource=admin" >> .env
# For windows users. Create a .env file in the 'src' directory
TOKEN=
STATUS=DEVELOPMENT
GUILD_ID=973562496763953200
MONGODB_URI=mongodb://admin:root@localhost:27017/bookmark?authSource=admin
```
Step 4: Return back to app and run the bot
```bash
# linux
cd .. && node .
# For windows users.
# Open up a cmd and locate Bookmark/app
node .
```