README.md
# Atena
<img src="https://s3-sa-east-1.amazonaws.com/assets.impulso.network/images/impulsonetwork-logo.svg" style="width: 100%">
[](https://codeclimate.com/github/universoimpulso/atena/maintainability)
[](http://impulso.network)
[](LICENSE)
[](https://twitter.com/UniversoImpulso)
[Documentação em Português](docs/README_PT_BR.md)
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:
- [Github](https://github.com)
- [Wordpress](https://br.wordpress.org/)
## Setup
Here is a walkthrough of the minimum configuration you need to get Atena running:
### Initial setup
- Have installed [Mongodb](https://docs.mongodb.com/manual/installation/)
- Have installed [Yarn](https://yarnpkg.com/lang/pt-br/)
### Development
- [`Fork`](docs/FORK.md) the project to your account
- Then, make a `clone`:
```sh
> git clone https://github.com/{your account}/atena
```
- Navigate to the destination folder where you clone the project:
```sh
> cd atena/
```
- Install the dependencies using `yarn`:
```sh
> yarn -i
```
- Add remote references from Atena:
```sh
> 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 Github Integration
To use Github integration, follow the documentation steps by clicking [here](docs/GITHUB.md).
### Configuring Wordpress Integration
To use Wordpress integration, follow the documentation steps by clicking [here](docs/WORDPRESS.md).
### Running in development environment
Start the server using the following command:
```sh
> yarn start:dev
```
### Debug
If you want to use a debug, start the server with the following command:
```sh
> yarn start:dev:debug
```
### Run node inspect in another terminal
```sh
> 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.
[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/0) [](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/1)[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/2)[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/3)[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/4)[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/5)[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/6)[](https://sourcerer.io/fame/goldblade/impulsonetwork/atena/links/7)
### [Code of Conduct](docs/CODE_OF_CONDUCT.md)
Impulso Network has adopted a Code of Conduct to guide our participants. Please read [Code of Conduct](docs/CODE_OF_CONDUCT.md) for more infos.
### [Contribution Guide](docs/CONTRIBUTING.md)
Read our [contribution guide](docs/CONTRIBUTING.md) 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
💬 Join the community in [Impulso Network](https://impulso.network)
## License
This project is licensed under the MIT license - see the [LICENSE](LICENSE.md) file for details.