nanoURL

README

NANOurl

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Installation
  • Environmental Variables
  • Running
• Testing
  • Running Unit Tests
• API Documentation
• Functional Documentation
• Roadmap
• Contributing
• License
• Contributers

About The Project

nanoURL is url shortner app https://nano--url.herokuapp.com/

Built With

• Redis
• GO
• Fiber

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps. You need to install golang if you have redis on port 6379 it will run on it else it will run on a fake redis

Installation

1. Clone the repo

git clone https://github.com/fuboki10/nanoURL.git

1. Install dependencies

go get ./...

Running

1. Build

go build

1. Run

./nanoURL

Testing

run the following script:

go test -v ./...

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 AmazingFeature-Feat)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin AmazingFeature-Feat)
5. Open a Pull Request

License

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

Demo

Contributers

Abdelrahman Tarek