Skip to content
This repository has been archived by the owner on Apr 21, 2024. It is now read-only.

Commit

Permalink
feat: update project name and link
Browse files Browse the repository at this point in the history
  • Loading branch information
GetPsyched committed Sep 25, 2023
1 parent 49527c5 commit 54d3941
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
NKSS Breadboard
===============

.. image:: https://img.shields.io/github/go-mod/go-version/NIT-KKR-Student-Support-System/breadboard?logo=Go
.. image:: https://img.shields.io/github/go-mod/go-version/nkss-dev/breadboard?logo=Go
:target: https://go.dev
:alt: Go version info

A RESTful API wrapper for the database our project, `NKSSS <https://github.com/NIT-KKR-Student-Support-System>`_, relies on!
A RESTful API wrapper for the database our project, `NKSS <https://github.com/nkss-dev>`_, relies on!

Running a local instance
------------------------

1. **Clone the repository:** ``git clone https://github.com/NIT-KKR-Student-Support-System/breadboard``
1. **Clone the repository:** ``git clone https://github.com/nkss-dev/breadboard``

2. **Setup initial configuration:** Populate ``sample.env`` with its corresponding values.
- The ``HMAC_SECRET`` can be any string you like as long as you have a valid JWT token for it. To generate this token, please execute ``go run dev/genjwt.go <role> <rollno>`` in the root directory *after* setting this env variable.
Expand Down
2 changes: 1 addition & 1 deletion server.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func (s *server) Run() {
// setRouters maps endpoints to the functions they must route to.
func (s *server) setRouters() {
s.router.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Welcome to NKSSS' API!"))
w.Write([]byte("Welcome to NKSS' API!"))
})

// Status
Expand Down

0 comments on commit 54d3941

Please sign in to comment.