Skip to content

Latest commit

 

History

History
123 lines (79 loc) · 3.43 KB

README.md

File metadata and controls

123 lines (79 loc) · 3.43 KB

Stargazers


ADVICE HUB

The perfect advicer.
Visit Advice Hub >>

Table of Contents
  1. About The Project
  2. Getting Started
  3. Host platform
  4. Contributing
  5. License
  6. Contact

About The Project

ADVICE HUB is a simple one page website. It shows many advices and quotes of great persons and can be followed in life. The website shows the advice or quotes and also the name of the author who has given the quote. I have used go lang to make the backend of this project. Used HTML, CSS and Javascript for the forontend. And used sqlite as the database.

(back to top)

Getting Started

Working with the website is pretty easy. You can easily get a piece of advice by clicking on the seek advice button. You can visit this github repo by click on the github repo button.

API Usage

You can use our api which has many advices and their authors. The following operation are performed on the API -

  • GET the all the advices.
  • GET only one advice with a specific id.
  • POST an advice to the api
  • PUT - update a specific api
  • GET a random advice from the advices in the advice api.

You has only access to the get operations but you cannot add or update the advices.

Just go to the website and perform these -

  • To GET all the advices put /advices
  • To GET a specific advice put /advices/:id
  • To GET a random advice put /suradvice

Else commands can be done by the admin, i.e ME

(back to top)

Host Platform

The website is hosted on render

(back to top)

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". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b advicehub)
  3. Commit your Changes (git commit -m 'Add some advices')
  4. Push to the Branch (git push origin advicehub)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

SHREEJAN - livin.cool.boy

Project Link: https://github.com/CapedDemon/advicehub

(back to top)