Atena

Documentação em Português

Atena is an initiative of the impulse in collaboration with several Impulsers, with the objective to promote the engagement and to reward the activities and efforts of each person in the Impulse. In it you will be able to acquire Reputation Points through the execution of several activities and based on these two factors, the Impulsers will receive levels and achievements recognizing the effort expended in the activities.

Integrations

Atena has integrations with:

• Rocket.Chat
• Github
• Wordpress

Setup

Here is a walkthrough of the minimum configuration you need to get Atena running:

Initial setup

• Have installed Mongodb
• Have installed Yarn

Development

• Fork the project to your account

• Then, make a clone:

> git clone https://github.com/{your account}/atena

• Navigate to the destination folder where you clone the project:

> cd atena/

• Install the dependencies using yarn:

> yarn -i

• Add remote references from Atena:

> git remote add upstream https://github.com/universoimpulso/atena

• Create a .env file at the root of the project by copying and renaming the .env.example file and subsequently changing some values ​​cited below:

Configuring Rocket.Chat Integration

To use Rocket.Chat integration, follow the documentation steps by clicking here.

Configuring Github Integration

To use Github integration, follow the documentation steps by clicking here.

Configuring Wordpress Integration

To use Wordpress integration, follow the documentation steps by clicking here.

Running in development environment

Start the server using the following command:

> yarn start:dev

Debug

If you want to use a debug, start the server with the following command:

> yarn start:dev:debug

Run node inspect in another terminal

> node-inspect localhost:9229

Contributing

The main purpose of this repository is to continue to evolve Atena, making it faster and easier to use.

Athena's is a open-source project, and we are grateful to the community for contributing with bug fixes and improvements. Read more to learn how you can participate in improving Athena and the Impulso network.

Code of Conduct

Impulso Network has adopted a Code of Conduct to guide our participants. Please read Code of Conduct for more infos.

Contribution Guide

Read our contribution guide to learn about our development process, how to propose bug,fixes and improvements, and how to build and test your changes in Atena.

Community

All comments and suggestions are welcome and can be made via Issues on Github or on RocketChat!

💬 Join the community in Impulso Network

License

This project is licensed under the MIT license - see the LICENSE file for details.