Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 4.38 KB

README.md

File metadata and controls

90 lines (57 loc) · 4.38 KB
Raw

ConMoney

Build Status Codacy Badge contributions welcome Bugs The MIT License

ConMoney developed to manage the money of users and showing the balance of your credits and debits 🌐 💰

Using ConMoney to manage your credits and debits, you will have a better control of your money, your bills and how much money you saved in the last few months.

NodeJS Express Sequelize PG React Redux Typescript Highcharts Docker Docker Compose
10.16.0 4.17.1 5.21.5 7.18.2 16.8.5 4.0.1 3.3.4 8.0.4 19.03.4 1.24.1

Colors:

  • #eff1f9 #eff1f9
  • #383f53 #383f53
  • #67b1bd #67b1bd
  • #d43763 #d43763
  • #4aa7ee #4aa7ee

Getting Started

I recommend use NPM or Yarn as package management and install all dependencies using it, running yarn or npm install inside each folder (app and api).

If you have some issues related to permissions, just add the sudo command before yarn/npm command, as sudo yarn.

Environment Variables

One important thing before start running this project locally is set up all environment variables. You can set them for back-end creating a .env file on api folder root and following this structure:

  APP_SECRET=You can set some application secret here to create user password encryption
  APP_DOMAIN=App Domain with port, probably http://locahost:3000 at this moment.
  EMAIL_DOMAIN=E-mail used to send 'Forgot password' to the user's email.
  EMAIL_PASS=E-mail password.
  POSTGRES_HOST=Docker host
  POSTGRES_DB=Database name
  POSTGRES_USER=Database user
  POSTGRES_PASSWORD=Database password

You should do the same on front-end, adding an .env file to app folder root:

  REACT_APP_API_URL=Api domain with port, probably http://localhost:3333 running it locally.

Back-end

Inside api folder, you should run the following command which will use docker to start up our server:

docker-compose up

Front-end

Inside app folder, you should run the following command, opening the project at localhost:3000:

yarn start

You can replace the command above for npm run start if you are using NPM as package management.

Tests

You can run yarn test inside app folder for Front-end tests. The same you can do on api folder for Back-end tests with npm run test.

Contributing

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

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Gabriel Hahn Schaeffer

See also the list of contributors who participated in this project.

License

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