mirror of
https://github.com/hmajid2301/DEPRECATED-banter-bus-core-api.git
synced 2026-06-20 04:05:24 +01:00
A web service written in NodeJS leveraging socketsio
- TypeScript 92.4%
- Shell 3.7%
- Makefile 2.2%
- JavaScript 1%
- Dockerfile 0.7%
|
|
||
|---|---|---|
| .devcontainer | ||
| .husky | ||
| .vscode | ||
| migrations | ||
| src | ||
| tests | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.dist | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.js | ||
| babel.config.js | ||
| config.example.yml | ||
| database.json | ||
| docker-compose.yml | ||
| Dockerfile | ||
| jest.config.js | ||
| Makefile | ||
| nodemon.json | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Banter Bus Core API
Running using devcontainer
The easiest way to setup this project is to use vscode's development containers. For this you will need:
- vscode
- Remote - Containers
First make a copy of the example files:
cp config.example.yml config.yml
cp .devcontainer/devcontainer.example.json .devcontainer/devcontainer.json
cp .devcontainer/config.example.sh .devcontainer/config.sh
The reason for this is so we can customise our development environment. For example I like to use fish shell instead of bash.
Example config.sh file
#!/bin/bash
# Name of the folder to copy files to in project (this folder should get deleted)
export temp_config_dir=.temp-config
# List of files to copy from host machine (relative to home directory) to docker container
export paths_to_port=(.config/fish)
# List of commands to run after the container is running
install_cmds() {
apt-get install fish fzf httpie vim -y
curl -fsSL https://starship.rs/install.sh | bash -s -- --yes
}