☰

Docs

Guide

Install

Introduction

Gymscribe is an open source advanced gym membership management app for gym owners to track and manage memberships easily. carefully created with vanilla css and PostgreSQL using various libraries.

Gymscribe is different because you can run it locally by downloading the source code and host it on your own server.

Gymscribe is free for everyone.

Welcome to Gymscribe!

Gymscribe Banner

Features

Gymscribe have various of features enough to manage a small and scalable gyms.

List of Gymscribe features:

  1. JWT Authentication
  2. PostgreSQL Database
  3. Altcha Captcha
  4. Manage Members (CRUD)
  5. Members Data Analytics
  6. Export Members To .CSV
  7. Journals + Save To DB
  8. Attendance System
  9. Attendance Data Chart
  10. /GET RESTAPI For The Gym Data
  11. And Many Other Stuff!

Tech Stack

Gymscribe is made using standard and modern technology.

List of tech stack used:

  1. HTML
  2. CSS
  3. Javascript
  4. NodeJS
  5. Express
  6. Prisma
  7. Neon
  8. PostgreSQL
  9. Altcha
  10. Chart.JS
  11. Vercel
  12. Railway
  13. etc.

Ideas

The ideas and vision of Gymscribe :)

I was wondering why there is no such thing as easy and quick gym manager for every gym owners? well, introducing... Gymscribe! a free and open source gym membership manager because we belive managing memberships doesn't requires a subscriptions. ♥️

Install

This section will explains step by step on how to install Gymscribe on your own device/server/vps or deploy it somewhere online.

This section will also explains how to configure and setting things up to make yout own Gymscribe run.

Install Frontend

This is guide for installing the Gymscribe frontend and run it locally.

1. Install VS Code and Git.

(You can use any code editor).

2. Clone Gymscribe files using Git in your terminal.

git clone https://github.com/alarixfr/gymscribe.git

3. Open the folders in your code editor.

Using terminal:

cd gymscribe

4. Configure the ./assets/js/handler.js.

Adjust the DASHBOARD_URL, LOGIN_URL variable to correct html path or url.

5. Open index.js in your browser or use Live Server.

Important: If you have your own api or cloned Gymscribe api, you can connect it by configuring the ./assets/js/handler.js file, right in the API_URL variable.


Install Backend

You can modify how things go inside your own Gymscribe by running the server locally.

1. Install Node.js latest version.

2. Clone Gymscribe backend files using Git in your terminal.

git clone https://github.com/alarixfr/gymscribeBackend.git

3. Open the folder in your code editor or terminal:

cd gymscribeBackend

4. Install dependencies in your terminal:

npm install

5. Create a Neon database:

Go to https://neon.tech/.

Then create a new account or login to an existing account.

Create a new project and pick any/closest region.

Copy the connection string.

Keep your connection string private!

6. Create .ENV:

Create a new .env file inside the project folder.

Terminal:

touch .env

Copy, paste in the .env file and modify it:

# Database DATABASE_URL="paste_your_neon_url_here" # JWT Secret (change this to random string) JWT_SECRET="random-string-change-this-abcdef" # Altcha Secret (for CAPTCHA) ALTCHA_SECRET="random-string-change-this-abcdef" # Port (optional, defaults to 8080) PORT=8080

7. Initialize Database:

npx prisma generate

then,

npx prisma migrate dev --name init

8. Run the server:

npm start

🎉 DONE!!

You now have the server runs locally, you can modify the code yourself or deploy it using VPS!

Make sure you already configure the ./assets/js/handler.js variables in the Gymscribe Frontend folders if you are using it locally too!

Security And Privacy

Your data is stored in 3rd party database. We can't guarantee the safety of your account and gym data. We suggest installing Gymscribe locally to ensure yout data safety.

Even though we have Altcha captcha in our login system, Gymscribe is still vunerable from various cyber attacks.

By installing Gymscribe locally, you are running your own service and you have full control to privacy.

License

Gymscribe is licensed under Apache License 2.0.

In short, you are free to use it for almost any purpose, including personal and commercial products.

You may copy the code, modify it, extend it, and redistribute it. You are also allowed to use it alongside proprietary or closed-source code, this mean you are not required to open source your entire application.

Keep in mind that there are a few required conditions if you redistribute the original code or in modified version. You must keep the original copyright notice and include the Apache License 2.0 text, and you must clearly indicate any changes you have made.

You may not claim the original work as entirely your own, nor may you use the project's name, logo, or branding in a way that implies official endorsement or ownerships.

Gymscribe is provided "as is," without warranties of any kind. The author makes no guarantee and is not liable for bugs, data loss, or any damage caused by the uses.

Try Gymscribe