https://github.com/mowlcoder/goph-keeper
https://github.com/mowlcoder/goph-keeper
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mowlcoder/goph-keeper
- Owner: MowlCoder
- Created: 2024-01-21T16:41:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-15T22:00:28.000Z (over 2 years ago)
- Last Synced: 2025-04-02T09:12:45.497Z (about 1 year ago)
- Language: Go
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔐 Goph Keeper
## 💡 Overview
Goph Keeper is app for storing password, cards, texts and files. You can store locally and sync data between different clients whenever you want.
## 💻 Technologies
- **Language:** Go
- **Database:** Postgres
- **Documentation:** godoc, Swagger 2.0
## ▶️ Getting started
To get started with the Goph Keeper, follow these steps:
1. **Clone the Repository:**
```shell
git clone https://github.com/MowlCoder/goph-keeper.git
```
2. **Install Dependencies:**
```shell
go get .
```
3. **Configure Settings:** Create an `.env.client` and `.env.server` files and populate them based on the `.env.client.example` and `.env.server.example` files
4. **Build application:**
```shell
make build-server && make build-client
```
5. **Run application:**
```shell
make run-server
```
```shell
make run-client
```
## 📝 Documentation
For client documentation you need to run client and enter `help` command.
API documentation is available in the [docs](/docs) directory.