Report writing and vulnerability management platform.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Introducing Antimatter,a report writing and vulnerability management platform.

But why? Unlike other solutions, Antimatter aims to be easy to use, featuring a clean, bug-free interface.

Todo

(back to top)

Built With

This section lists any major frameworks/libraries used to make this project happen:

• React Framework: Next.js
• Component Library: shadcn/ui
• Icons: Lucide
• Collaboration: Liveblocks
• Database: MongoDB
• Document Templating: easy-template-x

(back to top)

Getting Started

Todo

Prerequisites

todo

Production Installation

1. To get started with Antimatter, first clone this GitHub repository.

git clone https://github.com/Antimatter-Reporting/Antimatter

2. Create a .env environment file and customise your Antimatter instance. Please refer to example.env for an example configuration.

3. Bring up Antimatter using Docker compose

docker compose up

Development Installation

1. Alternatively, to run Antimatter in development mode, clone this GitHub repository.

git clone https://github.com/Antimatter-Reporting/Antimatter

2. Create a .env environment file and customise your Antimatter instance. Please refer to example.env for an example configuration.

3. Install the prerequisites by executing the following command in the frontend and backend folders:

npm i

4. Bring up Antimatter using Docker Compose.

docker compose -f docker-compose.dev.yml up

(back to top)

Usage

Todo

Todo

(back to top)

Roadmap

• Documentation
• Collaboration features
• Multi-language support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Jamie Pegg - contact@jamiepegg.com

Project Link: https://github.com/Antimatter-Reporting/Antimatter

(back to top)

Acknowledgments

Todo

• Todo
• Todo
• Todo

(back to top)