https://github.com/thevahidal/soul

Skip to content Toggle navigation
 
Sign up

  * Product
      +  
        Actions
        Automate any workflow
      +  
        Packages
        Host and manage packages
      +  
        Security
        Find and fix vulnerabilities
      +  
        Codespaces
        Instant dev environments
      +  
        Copilot
        Write better code with AI
      +  
        Code review
        Manage code changes
      +  
        Issues
        Plan and track work
      +  
        Discussions
        Collaborate outside of code
      + Explore
      + All features
      + Documentation
      + GitHub Skills
      + Blog
  * Solutions
      + By Plan
      + Enterprise
      + Teams
      + Compare all
      + By Solution
      + CI/CD & Automation
      + DevOps
      + DevSecOps
      + Case Studies
      + Customer Stories
      + Resources
  * Open Source
      +  
        GitHub Sponsors
        Fund open source developers
      +  
        The ReadME Project
        GitHub community articles
      + Repositories
      + Topics
      + Trending
      + Collections
  * Pricing

[                    ] 

  *  
    #
    In this repository All GitHub |
    Jump to |

  * No suggested jump to results

  *  
    #
    In this repository All GitHub |
    Jump to |
  *  
    #
    In this user All GitHub |
    Jump to |
  *  
    #
    In this repository All GitHub |
    Jump to |

Sign in
Sign up
{{ message }}
thevahidal / soul Public

  * Notifications
  * Fork 1
  * Star 46

A SQLite RESTful server

License

MIT license
46 stars 1 fork
Star
Notifications

  * Code
  * Issues 11
  * Pull requests 0
  * Actions
  * Projects 0
  * Security
  * Insights

More

  * Code
  * Issues
  * Pull requests
  * Actions
  * Projects
  * Security
  * Insights

thevahidal/soul

This commit does not belong to any branch on this repository, and may
belong to a fork outside of the repository.
main
Switch branches/tags
[                    ]
Branches Tags
Could not load branches
Nothing to show
{{ refName }} default View all branches
Could not load tags
Nothing to show
{{ refName }} default
View all tags

Name already in use

A tag already exists with the provided branch name. Many Git commands
accept both tag and branch names, so creating this branch may cause
unexpected behavior. Are you sure you want to create this branch?
Cancel Create
9 branches 1 tag
Code

  *  
    Clone
    HTTPS GitHub CLI
    [https://github.com/t]

    Use Git or checkout with SVN using the web URL.

    [gh repo clone thevah]

    Work fast with our official CLI. Learn more.

  * Open with GitHub Desktop
  * Download ZIP

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

@thevahidal
thevahidal README updated
...
d9ecac7 Oct 29, 2022
README updated
d9ecac7

Git stats

  * 36 commits

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
core
studio ui improved
Oct 19, 2022
docs
logo updated
Oct 24, 2022
studio
studio styling imroved
Oct 29, 2022
CONTRIBUTING.md
README, CONTRIBUTING and logo added
Oct 11, 2022
LICENSE
Initial commit
Oct 5, 2022
README.md
README updated
Oct 29, 2022
View code
[                    ]
Installation Usage Documentation Development Core API Studio
Contributing Authors License

README.md

                               [logo]

                       A SQLite RESTful server

 Installation

Install Soul CLI with npm

  npm install -g soul-cli

 Usage

Soul is command line tool, after installing it, Run soul -d sqlite.db
-p 8000 and it'll start a RESTful API on localhost:8000.

Usage: soul [options]


Options:
      --version             Show version number                        [boolean]
  -d, --database            SQLite database file or :memory: [string] [required]
  -p, --port                Port to listen on                           [number]
  -r, --rate-limit-enabled  Enable rate limiting                       [boolean]
      --help                Show help                                  [boolean]

Then to test Soul is working run the following command

curl http://localhost:8000/api/tables

It should return a list of the tables inside sqlite.db database.

 Documentation

API documentation is available while the project is running at http:/
/localhost:8000/api/docs

 Development

git clone https://github.com/thevahidal/soul # Clone project

 Core API

cd core # Move into the core directory

cp .env.sample .env # Duplicate sample environment variables
nano .env # Update the environment variables

npm install # Install dependencies
npm run dev # Start the dev server

 Studio

Make sure that Soul Core API is up and running and then

cd studio # Move into the studio directory

cp .env.sample .env # Duplicate sample environment variables
nano .env # Update the environment variables

npm install # Install dependencies
npm run dev # Start the dev server

 Contributing

Contributions are always welcome!

See contributing.md for ways to get started and please adhere to code
of conduct.

 Authors

  * @thevahidal

 License

MIT

About

A SQLite RESTful server

Resources

Readme

License

MIT license

Stars

46 stars

Watchers

3 watching

Forks

1 fork

Releases

1 tags

Packages 0

No packages published

Languages

  * JavaScript 82.4%
  * Svelte 16.3%
  * Other 1.3%

Footer

 (c) 2022 GitHub, Inc.

Footer navigation

  * Terms
  * Privacy
  * Security
  * Status
  * Docs
  * Contact GitHub
  * Pricing
  * API
  * Training
  * Blog
  * About

You can't perform that action at this time.
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session.