Easy Wallet - API

This is the back end of the Easy Wallet project, a web application that helps you to manage your finances.
Status: Development
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Prepare for production
3. Contributing
4. License
5. Contact

About The Project

Easy Wallet is a web application that allows users to manage their finances. It was made with the purpose of helping people to organize their money and to have a better understanding of their expenses and incomes.

This project was made as a side project with the purpose of getting familiar with the technologies used in the development of the application.

Built With

• Golang
• Echo
• GORM
• PostgreSQL
• Docker

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to run this project, you need to have installed

• Golang*
• Nodejs and npm (in case you want to use nodemon)
• Docker and docker-compose (in case you want to use the provided docker-compose file to run the PostgreSQL database)

You also need to have access to the a:

• PostgreSQL database (or use the provided docker-compose file)
• Mailjet account

Installation

1. Clone the repo

   git clone https://github.com/TiagoRibeiro25/Easy-Wallet-BE.git

2. Install NPM packages (in case you want to use nodemon)

3. Install Go packages

   go mod download

4. Create a .env file, add the variables in the .env.example file and fill them with your own values.

5. Have a PostgreSQL database running (or use the provided docker-compose file)

6. Run the project

• Using nodemon

  npm run dev

• Using go run

  go run ./src

Prepare for production

1. Run the go mod tidy command to install the dependencies

   go mod download

2. Build the project

• Using npm

  npm run build

• Using go build

  go build -o ./dist/easywalletapi ./src

3. Set the GO_ENV variable to production and the rest of the variables in the .env file

4. Run the project

   ./dist/easywalletapi

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".

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

License

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

Contact

Contact through my personal website.