Skip to content

gerjunior/secret-friend

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Secret Friend

Who's mine?
Report a Bug · Request a Feature

Index

About the project

After starting GoStack, I decided that I had to proof my acknowledments for myself by doing something that uses everything that I learned: frameworks, libs, concepts, language. I picked up a college task and turned it bigger, applying everything I knew.

Tools

Getting Started

Prerequisites

You will probably need to install Docker. You can do this by clicking here.

Installation

  1. Clone the repo
git clone https://github.com/gerjunior/secret-friend
  1. Go inside the api folder
cd api
  1. Install packages
yarn install
  1. Create a postgres and redis instance in docker
docker run --name postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 postgres
docker run --name redis -p 6379:6379 -d -t redis:alpine
  1. Create a new database for the project and configure the connection. Name it "secret-friend" PS: You can use DBeaver to create the database.

  2. Create a new file inside the api folder named .env. Copy and paste the content of .env.example inside it.

  3. Start the api

yarn dev:server

or

yarn start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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

Contact

Acknowledgements