Acumen

Table of Contents

• About The Project
• Building From Source
  • Prerequisites
  • Configuring Environment
  • Frontend
  • Backend
• License

About The Project

Acumen is an open source, self-hosted, project management server.

Building from Source

Acumen consists of a separate frontend and backend, both using the Node.js runtime environment.

• The backend is built using the Express.js framework.
• The frontend is built using the React.js library.

Prerequisites

• Node.js (v20.11.1 or above)

Begin by cloning the repo:

git clone https://github.com/justinsprecco/Acumen

Configuring Environment

• Copy the example environment from the server root:

cp server/.env.example server/.env

• Configure the .env with your credentials:

AWS_ACCESS_KEY_ID=[personal_aws_access_id]
AWS_SECRET_ACCESS_KEY=[personal_aws_access_key]
AWS_REGION=[desired_region]
JWT_KEY=[private_user_specified_key]
PORT=[server_port]

Frontend

1. Navigate into the client directory: cd client
2. Install dependencies: npm install
3. Run development server: npm run dev
4. Visit http://<hostname>:5173 to access the web interface.

Backend

1. Navigate into the server directory: cd server
2. Install dependencies: npm install
3. Run development server: npm run dev
4. Web server is available at http://<hostname>:<PORT>.

License

Distributed under the MIT License. See LICENSE for more information.