Giter VIP home page Giter VIP logo

grimoire's Introduction

Grimoire

Basically a notes and calendar app I use for all my notes. Will expand on this further.

Live version open for user sign ups here https://grimoireautomata.com/. Please keep in mind I am not offering an encryption so it is possible for me to view any data created in production.

Architecture

Will expand on each choice here eventually

Local

nvm use is necessary to npm install

Setup

  • Use a linux based operating system. Might work on windows, but I do not test on that.
  • Run sudo apt-get update
  • Run sudo apt-get install -y build-essential python for bcrypt
  • Install nvm https://github.com/nvm-sh/nvm
  • Clone this repository
  • nvm install X where X is the version of node in .nvmrc
  • nvm use to change the node version of the current console to match that of .nvmrc. THIS MUST BE DONE EACH TIME YOU OPEN A NEW CONSOLE (unless you setup nvm to automatically do this on cd)

Both services currently connect to the production PostgresSQL database. In the future I would like to use a locker docker-compose file to setup a local postgres database. Then use a seeding script to setup data.

Prod

Environment Variables

  • DATABASE_URL - Full url with credentials for PostgresSQL.
    • Local=In the future when I setup the local PostgresSQL server I'll post that url here. For now this cannot be checked into the repo since I use the PostgresSQL prod database.
  • SECRET - A randomly generated string used for jwt signing. Just random letters, numbers and symbols. Around 24 characters should be fine. F
  • NEXT_PUBLIC_GRAPHQL_URL

grimoire's People

Contributors

emmajsadams avatar dependabot[bot] avatar

Stargazers

Roman avatar

Watchers

 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.