website

command module
v0.0.0-...-4cc3681 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2024 License: AGPL-3.0 Imports: 6 Imported by: 0

README

Lines of code

Tarkov Database Website

The main presence, the website of Tarkov Database which presents the data of the API in a friendly way.

The project follows the KISS principle and focuses on the same things as the REST API: scalability, efficiency, performance, and simplicity. It is also designed as a stateless service for use in a distributed system.

Set up a local development environment

Prerequisites
Set up
1. Set up local REST API
2. Clone this repository
git clone git@github.com:tarkov-database/website.git && cd website
3. Install NPM modules
npm i
4. Build static files
make statics
5. Create environment variable file

Create a file with the name .env in the root directory and the following content (add the appropriate variables)

export HOST=localhost:8080
export API_URL=http://localhost:9000/v2
export API_TOKEN=<TOKEN>
export SEARCH_HOST=http://localhost:9100
6. Start the server
make run

The server should now be accessible via localhost:8080

7. Install Revive linter (optional)
go install github.com/mgechev/revive@v1
8. Install Prettier editor integration (optional)

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
bundler module
core
api
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL