Giter VIP home page Giter VIP logo

spg's Introduction

SPG App

This project is an admin tool designed to digitize Suraj Prakash into a central database. You can find the spg.dev front-end repo over here

Running Locally

As of right now, this repo is public however the the database is not.

Make sure you have the following setup:

  • Node v12.18.3
  • MySQL 5.7
  • Knex JS
  1. Clone the repo: git clone [email protected]:dsomel21/spg.git

  2. Install dependencies:

cd spg && yarn
cd client && yarn
  1. Create the Database and create a .env file in the root directory of the repo and paste the following details:
DATABASE_HOST="localhost"
DATABASE_USER="YOUR_MYSQL_USERNAME"
DATABASE_PASSWORD="YOUR_MYSQL_PASSWORD"
DEVELOPMENT_DATABASE="THE_DATABASE_YOU_JUST_CREATED"
  1. Run Migrations and seeds:
knex migrate:latest
knex seed:run

NOTE: We may have to run this with npx.

  1. Run Server:

Run yarn start in the root directory and this will boot-up the API in localhost:1469/. Then run yarn start in client/ directory to run the admin section. You can now run the app in localhost:3000/

Tools

  • NodeJS/Express: Building Rest API
  • PostgreSQL: For DB.
  • MySQL For DB (support + documentation made me move)
  • TypeScript: Schema validations (in progress)
  • Knex: Query builder! Not ORM.
  • React: Cuz why not

Project

ਉਨਿਸ ਸਤ ਪੂਰੇ ਭਏ ਸ੍ਰੀ ਸੰਤੋਖ ਮ੍ਰਿਗੇਸ । ਸ੍ਰੀ ਸੂਰਜ ਪਰਕਾਸ ਕਿਅ ਅਦਭੁਦ ਗ੍ਰੰਥ ਬਿਸੇਸ ।⁣

In 1900 Bikrami (1843 CE) the Exalted Santokh Singh completed the magnificent and marvelous Suraj Prakash.

ਜਾ ਸਮਾਨ ਕਉ ਗ੍ਰੰਥ ਨ ਆਨਾ । ਸਤਗੁਰੁ ਜਸ ਕਰ ਮਨਹੁ ਖਜਾਨਾ । ⁣

There is no other [historical] text equal to the Suraj Prakash - recognize it as the treasure trove of praise of the True Guru.⁣

ਰਚ ਜਹਾਜ ਜਗ ਸਿੰਘ ਤਰਾਏ । ਸ੍ਰੀ ਸੰਤੋਖ ਸਿੰਘ ਜਸ ਆਏ । ⁣

The Exalted Santokh Singh acquired great praise; in this world he created this vessel to liberate all the Singhs.

Baba Sumer Singh - 'Gurpad Prem Prakash' (1880), page 527.⁣ (Translation by Manglacharan)

Kavi Santokh Singh Ji has contributed his life to poetically documenting the life of the Sikh Guru's. This project strives to create a central database for Kavi Ji's Gurprataap Sooraj Granth (also known as Sooraj Prakash Granth) using the admin tools in this application.

Recommended Links:

  • Suraj Podcast - An amazing podcast in English that goes through chapters of SPG

  • Rara Sahib (formerly on ik13.com) - Amazing service of publishing volumentric documents on SPG

  • shabados/Gurmukhi-Utils - Very useful tool to for when dealing with transliteration/ASCII/unicode converting in the context of the Gurmukhi language. This has COMPLETE code coverage.

Images:

spg's People

Contributors

dependabot[bot] avatar dsomel21 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

spg's Issues

Create Project Logo

Before any "big release," the project should have a project logo in the README document.

"Vivind Visuals" of Waterloo, ON, will be drafting the first project logo.

Here is one of sketches she made:

Screen Shot 2020-10-01 at 12 04 06 AM

Screen Shot 2020-10-01 at 12 04 24 AM

Screen Shot 2020-10-01 at 12 04 49 AM

Edit: These are some of the sources I provided the artist:

image

image

image

Finalize API

  • Adding chapter artwork
  • English translation section on tuks
  • English translations on the chapter name
  • Fething kathas, etc.

Refactor to allow adding chhands/pauris in a different order

This is going to be a pretty big refactor, but it shouldn't be too complex.

  • Right now, adding chhand only adds to the last book, last chapter.
  • Adding a pauri, will automatically add it to the last book, last chapter, last chhand and so fourth.

We have to break this by allowing chapter_id or book_id arguments so we can add it wherever we want.

Deploy to AWS

This is what I was reading last time.

For some reason, I can't SSH into the EC2 instance.

This is the tutorial I was following

OpenSSH_8.1p1, LibreSSL 2.7.3
debug1: Reading configuration data /etc/ssh/ssh_config
debug1: /etc/ssh/ssh_config line 47: Applying options for *
debug1: Connecting to 3.XXX.YY.123 [3.XXX.YY.123] port 22.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.