https://github.com/novara754/shortpost

Minimal Twitter clone written in Go. Features user accounts, sessions and a basic timeline with posts.
https://github.com/novara754/shortpost

Last synced: 30 days ago
JSON representation

Minimal Twitter clone written in Go. Features user accounts, sessions and a basic timeline with posts.

• Host: GitHub
• URL: https://github.com/novara754/shortpost
• Owner: novara754
• License: mit
• Created: 2020-10-07T16:03:25.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-10T14:36:18.000Z (about 4 years ago)
• Last Synced: 2024-01-14T23:13:16.706Z (12 months ago)
• Language: Go
• Size: 34.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shortpost

A minimal twitter clone with user accounts, sessions, and a timeline.

![Screenshot of the website with some sample posts](./screenshot.png)

## Building & Running

To compile the program simply run `go build -o shortpost.out ./shortpost`, this will

generate an executable with the same name.

In order for the executable to work you need to launch it with proper values

in the `PORT` and `POSTGRES_URL` environment variables. For example:

```

$ PORT=8080 \

  POSTGRES_URL="postgres://user:password@localhost:5432/shortpost:?sslmode=disable \

  ./shortpost.out 

```

The server will then listen on the configured port.

### With Docker

You can also easily launch the server along with a Postgres instance using the provided

`docker-compose.yml`. Simply run `docker-compose up -d` in the project root directory

to run the service as a daemon.

By default the webserver can be accessed on port `8080`, but this can be configured in the 

`docker-compose.yml` file.

## License

Licensed under the [MIT License](./LICENSE).