nairobi-gophers / fupisha

Fupisha is a modern url shortening service. Fupisha is a swahili word for Shorten.
MIT License
21 stars 10 forks source link
golang vuejs

fupisha

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Fupisha is a modern url shortening service.

:construction: Work In Progress! :construction: Contributions and bug reports are welcome. :tada:

Features

Stack

Setup

You need to have Golang installed at the very least Go 1.11. The easiest way to get started with fupisha in your local environment is to clone it using git:

 git clone https://github.com/nairobi-gophers/fupisha.git

Rename the example.env file to .env file and fill in all the config sections, these will be used by the server container to set up the necessary resources.For the smtp section the values must be valid and existing smtp account credentials.

Run

To run the application, you will need to ensure that you have the make utility installed and running in your local computer.If you have the make utility, then you can follow along with the below instructions.

Implemented Features

Sample HTTP Requests

curl -X POST -H "Api:v1" -d '{"email":"admin@fupisha.io","password":"iamjustauser"}' http://localhost:8888/auth/signup

It will involve the community and awesome technologies like:

Let's learn together.

License

Copyright 2020 Nairobi Gophers

Licensed under the MIT License