Skip to content

Latest commit

 

History

History
130 lines (88 loc) · 7.43 KB

README.md

File metadata and controls

130 lines (88 loc) · 7.43 KB

Inside Server

GitHub Stars GitHub Issues GitHub Pull Requests Codacy Build Status Gitter PRs Welcome

Inside is an open source platform to deal with all the intern process of a company related to its employees. Our goal is to make easy to keep a track and manage all information related to the people that work inside the company.

Inside Server Logo

Getting Started

To get started you will need to get a copy of the project, insert the following commands (one by one) on your terminal.

git clone [email protected]:ifactory-solutions/inside-server.git
cd inside-server
npm install

You will get a clone of the project, navigate to it, and install its dependencies.

The project was initiated with the awesome facebook's cli for react (create-react-app). So you have all its default commands available, like:

npm run build
npm run test
npm start

Prerequisites

You should have at least the LTS node version 6.11. We recommend you to use nvm it will make easy for you to switch between node/mpm versions.

Running the project

At the end of both following processes, you'll have a working GraphQL server running on the 5000 port (though you can change it by setting the environment).

Manually

Run npm start (into the project folder) to run the application over a local server.

cd inside-server
npm start

Docker

Be sure to have installed Docker and docker-compose.

docker-compose up

Built With

  • NodeJS - A JavaScript runtime built on Chrome's V8 JavaScript engine.
  • MongoDB - A document database.
  • KoaJS - A web framework.
  • GraphQL - A query language for APIs.
  • Jest - A library for unit test javascript code

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

Thanks goes to these wonderful people


Andre Luis Araujo Santos

Humberto Andrade


Célio T. Paiva Junior


Filipe Ivo


Henrique Andrade


Igor Moura


Italo Pessoa


Jefferson Matheus


Jouderian Nobre Junior


Jourdan Rodrigues


Valter Júnior


Ivan Kenji


Daniel Laurindo


Caroline da Silva Rodrigues


Lucas Azevedo


Paulo Gabriel


Wellyngton Amaral


Yann Braga

This project follows the all-contributors specification. Contributions of any kind are welcome!

License

This project is licensed under the MIT License - see the LICENSE site for details

Acknowledgments

  • Ifactory Team
  • Coders
  • All our loved users