basetool

(β˜… 285)

Open-source internal tool framework. πŸ’ͺ Empower your team and collaborators to view and manage the data you already own in a nice easy-to-use protected tool. Basetool helps you have a better handle on your data in a collaborative way so you can focus on moving your business forward.

  • .dockerignore
  • .editorconfig
  • .env.sample
  • .env.test.sample
  • .eslintignore
  • .eslintrc
  • .gitignore
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • cypress.env.json
  • cypress.json
  • Dockerfile
  • LICENSE.MD
  • next-env.d.ts
  • next.config.js
  • package.json
  • postcss.config.js
  • README.md
  • sentry.client.config.js
  • sentry.properties
  • sentry.server.config.js
  • tailwind.config.js
  • tsconfig.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/basetool-ai/basetool

Downloads the entire project code from GitHub to your computer.

cd basetool

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f deploy/docker/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation