adityaparab / ghdb Goto Github PK

There is no way for users to select a folder where they want the repository to be checked out from the UI.

Implement the API that will provide JSON that contains file system tree.

When user arrives at root route of the project (/) the server will return client side page.
The Angular project responsible for rendering front end can be found under ./client folder.

Workflow is as follows

1. When user arrives at this route, make an API call to the server.
2. The API will return error if git repo is not configured correctly. If it returns error show the following screen
3. The API will return configuration object if git repo is configured correctly. If it returns configuration object, show the following screen with editing disabled.

Ignore Colors.

• Recommended CSS framework is @angular/material
• Use indigo theme.

Find out and fix the issues, if any, during the initial repository setup and reconfiguration of already existing repository.

Implement Generic PUT routes that can update documents.

Specs:
PUT: /:collectionName
BODY: Updated JSON Object that already exists in database[collectionName] with updated properties

Prerequisites:
There exists a json file with minimal structure

{
  "recipes": [
    { "_id": "x1y2z3", "name": "Tomato Soup" }
  ]
}

Example:
PUT: /recipes
BODY - { "_id": "x1y2z3", "name": "Tomato Soup UPDATED" }

Output:

{
  "recipes": [
    { "_id": "x1y2z3", "name": "Tomato Soup UPDATED" }
  ]
}

Implement Generic post routes that can create documents.

Specs:
POST: /:collectionName
BODY: JSON Object to be created

Prerequisites:
There exists a json file with minimal structure

{
  "recipes": []
}

Example:
POST: /recipes
BODY - { "name": "Tomato Soup" }

Output:

{
  "recipes": [
    { "_id": "some randomly generated unique string", "name": "Tomato Soup" }
  ]
}

Title says it all.

What needs to be explained in the README?

Problem-
Finding a free json based database host can be trouble. There are restrictions and/or limitations in terms of bandwidth, data storage etc. Even if one finds such provider it involves creating new account and remembering an additional password. Free tier accounts have most features disabled and thus are not very friendly towards beginners who say I don't care about the rest I just want this simple data to be persisted

Solution:
This project solves these problem by using github repo to store database. Data is persisted on both remote and local repository.
There is a server that abstracts away data manipulation logic between github and the user.
The user provides data along with name of the collection in the database, and the server does appropriate operation based on METHOD of rest api request.
The server manipulates local repo database and periodically commits the database updated to the remote repo.

How to use:
Will be added once the MVP is complete

Title says it all.

Implement Generic DELETE routes that can delete a document.

Specs:
DELETE: /:collectionName
BODY: Document to be deleted.

Prerequisites:
There exists a json file with minimal structure

{
  "recipes": [
    { "_id": "x1y2z3", "name": "Tomato Soup" }
  ]
}

Example:
DELETE: /recipes
BODY - { "_id": "x1y2z3", "name": "Tomato Soup" }

Output:

{
  "recipes": []
}