Categorygithub.com/jakewhite8/notecards-server
modulepackage
0.0.0-20240629043619-6171dd684e48
Repository: https://github.com/jakewhite8/notecards-server.git
Documentation: pkg.go.dev

# README

Notecard Server

Contributors Forks Stargazers Issues


Notecards Server

A Gin REST API

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Run The App Locally
  3. Contact
  4. Acknowledgments

About The Project

This is the server for the Notecards application. The Notecards server accepts requests from the client, performs CRUD operations on a Postgres database, then sends responses back to the client. The corresponding User Interface is located in the Notecards repository

(back to top)

Built With

The server is built with the Go web framework, Gin. It uses GORM to interact with the Postgres database hosted on an Amazon RDS.

  • Go
  • Gin

(back to top)

Run The App Locally

Prerequisites

The server was built with version 1.20.11 of Go

Installation

  1. Clone the repo
    git clone https://github.com/jakewhite8/notecards-server.git
    
  2. From inside the notecards-server directory, install the project dependencies by running:
    go mod download
    
  3. Start the server:
    go run main.go
    
  4. Navigating to localhost:8080 should display the message: Notecards Server

(back to top)

Contact

Jake White - [email protected]

Project Link: https://github.com/jakewhite8/notecards-sever

(back to top)

Acknowledgments

Resources I found helpful and would like to give credit to

(back to top)

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author