Skip to content

rngzhi/forum-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Forum Backend

This project is developed based on CVWO sample app. The project now supports basic backend functionalities needed for a web forum application, where the frontend part can be referred here.

Getting Started

Installing Go

Download and install Go by following the instructions here.

Running the app

  1. Fork this repo.
  2. Clone your forked repo.
  3. Open your terminal and navigate to the directory containing your cloned project.
  4. Run go run cmd/server/main.go and head over to http://localhost:8000/users to view the response.

Navigating the code

This is the main file structure. Note that this is simply one of various paradigms to organise your code, and is just a bare starting point.

.
├── cmd
│   ├── server
├── internal
│   ├── api         # Encapsulates types and utilities related to the API
│   ├── dataacess   # Data Access layer accesses data from the database
│   ├── database    # Encapsulates the types and utilities related to the database
│   ├── handlers    # Handler functions to respond to requests
│   ├── models      # Definitions of objects used in the application
│   ├── router      # Encapsulates types and utilities related to the router
│   ├── routes      # Defines routes that are used in the application
├── README.md
├── go.mod
└── go.sum

Main directories/files to note:

  • cmd contains the main entry point for the application
  • internal holds most of the functional code for your project that is specific to the core logic of your application
  • README.md is a form of documentation about the project. It is what you are reading right now.
  • go.mod contains important metadata, for example, the dependencies in the project. See here for more information
  • go.sum See here for more information

About

A backend prototype supporting web forum functionalities

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages