mreetyunjaya / bulwark Goto Github PK

Bulwark is an organizational asset and vulnerability management tool designed for building and generating application security reports.

Please keep in mind, this project is very early in the development phase.

$ git clone (url)
$ cd bulwark
$ npm install

Run in development mode:

$ npm run start:dev

Run in production mode:

$ npm start

Create a .env file which will be parsed with dotenv.

DB_PASSWORD="somePassword"

Set this variable to database password

DB_USERNAME="foobar"

Set this variable to database user name

DB_URL=something-foo-bar.dbnet

Set this variable to database URL

DB_PORT=3306

Set this variable to database port

DB_NAME="foobar"

Set this variable to database connection name

DB_TYPE="mysql"

The application was developed using a MySQL database. See the typeorm documentation for more database options.

NODE_ENV=production

Set this variable to determine node environment

Only update if a different port is required

Only update if a different port is required

JWT_KEY="changeMe"

Set this variable to the JWT secret

JWT_REFRESH_KEY="changeMe"

Set this variable to the refresh JWT secret

FROM_EMAIL="[email protected]"

Set this variable to sender email

FROM_EMAIL_PASSWORD="somePassword"

Set this variable to sender email password or a Gmail app passwords

COMPANY_NAME="United Nations Space Command"

Set this variable to the application security company name to be published on the report

DB_PASSWORD=""
DB_URL=""
DB_USERNAME=""
DB_PORT=3306
DB_NAME=""
DB_TYPE=""
NODE_ENV=""
DEV_URL="http://localhost:4200"
PROD_URL="http://localhost:5000"
JWT_KEY=""
JWT_REFRESH_KEY=""
FROM_EMAIL=""
FROM_EMAIL_PASSWORD=""
COMPANY_NAME=""

1. Create the initial database migration

$ npm run migration:init

2. Run the initial database migration

$ npm run migration:run

1. Insert the first user by running the following command with the required arguments. Example:

$ node dist/init/seed-user.js --firstName=John --lastName=OneOneSeven [email protected] --title='Master Chief Petty Officer' --password=blueTeam

2. Login to Bulwark with the newly created user

• Typeorm - The ORM used
• Angular - The Angular Framework
• Express - A minimal and flexible Node.js web application framework

The Softrams Bulwark core development team are:

• Alejandro Saenz aka Whamo12
• Bill Jones aka skewled

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Read the contribution guidelines first.

MIT