Code Monkey home page Code Monkey logo

tskr's Introduction

Tskr

Tskr is a 0 to Low cost solution to track records and make automation accessible to everyone.

Features

Everything RedwoodJS has. Everything Prisma gives as well.

Roles Management

Users are only given access to create, read, update and delete records via roles. Roles are only given to a user from their groups.

Upcoming Features

  • Custom Generators that set up rules
  • Better looking UI
  • Internationalization set up with a simple key value messages file

Contributing

Contributions are always welcome!

We follow the Github Flow, we're still new to this so bear with us.

We review Pull Requests on Mondays and Wednesdays.

If you would like to work on an issue comment on it.

Running in Gitpod

  1. Fork the Repository.

  2. Goto your fork.

  3. Configure a PostgresDB

    This is a bit more involved but you'll need a database somewhere either on your machine or hosted somewhere. I generally set up a https://railway.app postgressql database

    • Provision a PostgreSQL project.
    • Click on PostgreSQL, then Connect.
    • Copy the Postgres Connection URL
  4. Set up your environment variables in gitpod.

    Name Scope Value
    DATABASE_URL yourName/tskr Connection String from above
    SESSION_SECRET yourName/tskr Well set this later
  5. Open in Gitpod

  6. When the terminal comes do the following.

  7. Push your schema to your database via yarn rw prisma migrate dev.

  8. Generate a new secret via yarn rw g secret.

  9. Copy that string and set it in the varables for gitpod.

  10. Stop your workspace via the menu. Then relaunch it.

Running locally

  1. Fork the Repository.

  2. Clone your fork

    git clone https://github.com/tskrio/tskr.git tskr
  3. Go to the project directory

    cd tskr
  4. Install dependencies

    yarn i
  5. Configure a PostgresDB

    This is a bit more involved but you'll need a database somewhere either on your machine or hosted somewhere. I generally set up a https://railway.app postgressql database

    • Provision a PostgreSQL project.
    • Click on PostgreSQL, then Connect.
    • Copy the Postgres Connection URL
  6. Configure Environment Variables

    Modify the ./.env file to have a DATABASE_URL and SESSION_SECRET. Paste in your connection string and add the following to the end.

    ?connection_limit=1
    

    It should look like so.

    DATABASE_URL=postgres://<user>:<pass>@<url>/<db>?connection_limit=1
    SESSION_SECRET=replaceme
    
  7. Push SQL to your database

    yarn rw prisma migrate dev
  8. Generate a new secret

    yarn rw g secret

    Update your ./.env file's SESSION_SECRET

  9. Start the server

    yarn rw dev
  10. Seed the database

    #not yet written

    Alt. intstructions

    • Start your server yarn rw dev
    • Open the browser and go to http://localhost:8910/
    • Signup
    • Open Prisma Studio yarn rw prisma studio
    • Identify your user's ID
    • Create a Group (note the ID)
    • Create a GroupMember with user's ID and group's ID
    • Create a GroupRole with group's ID, and role of admin

    From here on out, you can create groups, and users in the browser, but the initial user and rights needed to be set up. There's an issue with seeding on windows which is why these instructrions are ... long.

tskr's People

Contributors

jacebenson avatar shiningblue7 avatar

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.