Categorygithub.com/podcreep/server
modulepackage
0.0.0-20250305054042-b3090b60e24f
Repository: https://github.com/podcreep/server.git
Documentation: pkg.go.dev

# README

server

The podcreep backend server and API.

Getting Started

Check out the three repositories. Ideally you'll want them in the same root directory, so something like this:

$ mkdir podcreep && cd podcreep
$ git clone [email protected]:podcreep/server.git
$ git clone [email protected]:podcreep/web.git
$ git clone [email protected]:podcreep/android.git

Dependencies

Go 1.17 is required to run the server.

Running locally

In order to run locally, you need to have a postgresql database set up and running. Any decently modern version should do.

Environment variables and running

Next, we use a couple of environment variable to configure the database connection, debug mode and admin secret password.

Finally, run the server. But make sure the environment variable above are visible to it!

$ go run main.go

There's a helper script that makes running locally a bit easier:

$ python3 run.py

Running a client

See either android/README.md or web/README.md for instructions on running the clients.

# Packages

Package admin contains the backend-management features we use to manage feeds, etc.
No description provided by the author
No description provided by the author
No description provided by the author
Package rss ...
Package store contains methods and structures that we use to persist our data in the data store.
util is not the best name for a package.