Giter Club home page Giter Club logo

server's Introduction

Rema

A powerful and scalable certificate generation and management system for individuals, businesses, and organizations.


Rema Logo

Instructions

See the wiki for instructions on setup and development.

For other discussions, see the discussions page.

Execution (Docker)

Use Docker Compose to spin up the containers. Make the necessary changes to docker-compose.yml, if any.

docker compose up -d

The application will run on port 8080 of the host machine.

Execution

Install the dependencies for node-canvas in your operating system as specified here.

# Ubuntu
sudo apt install build-essential libcairo2-dev \
	libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

Install the dependencies for Rema locally.

cd src
npm ci

Set the desired environment variables.

# MongoDB URI (default: 'mongodb://localhost/rema')
export DB=mongodb://uri.to.mongodb/dbname

# Port (default: 8080)
export PORT=80

npm start

For more information, see the wiki.

Contributing

See the contribution guide.

Made with โค by Param.

server's People

Contributors

mitanshikshatriya avatar paramsiddharth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

server's Issues

Add placeholder support

Add placeholder support for both the template and certificate APIs.
Some good placeholders could be:

  • TEMPLATE_DATE
  • CERTIFICATE_DATE
  • CERTIFICATE_TITLE
  • TEMPLATE_TITLE
  • CERTIFICATE_UID

Retain unused columns

Add a new property to the certificate object (not certObj.values, certObj itself) and export it with the resulting response.

Dockerize Rema

Have both a Dockerfile and a docker-compose.yml ready for the containerization of Rema.

Create stock templates

Create the following stock templates:

  • stock-award
  • stock-best-award
  • stock-brilliance
  • stock-colourful-ornament
  • stock-curly-borders
  • stock-generic
  • stock-ornamental

Use relative paths for all image locations

Now that everything is being downloaded or accepted as an existing image, it is safe to assume that all images will be located at different locations in one directory (which could be a mounted object storage e. g. S3 in production).

Remove callbacks

Why use callbacks when we can use promises? Do the same for the validation method.

Hint: Pass by reference. ๐Ÿ˜Ž

Test SVG support

Test SVG background and field support for rendering:

  • Background
  • Fields

Return updated CSV with UID entries

Upon bulk certificate generation, respond with an updated CSV containing the same data with an additional column: REMA_CERT_UID, containing the UID.

Add trigger to initialize stock template database

Check for the presence of the stock templates in the database and their files in the INTERNAL_STATIC_DIR.
Whichever found missing, fix using the contents from the builtins directory in Rema's root and the src/initDB.js script to fix the database.

Document placeholders

Placeholders including:

  • Those in the bulk CSV column-names.
  • Those in certificate/template objects.

Create template API

Create a REST API for CRUD operations on the templates:

  • Create
  • Extend existing
  • Get all
  • Get
  • Render and retrieve a preview
  • Patch/Update
  • Delete
  • Delete all

Create certificate API

Create an API that allows using existing templates to create certificates.

Some points need to be taken care of:

  • The certificate must only store a reference to the template it extends (via its identifier)
    and the values it provides the template's fields.
  • #26
  • Needs to have a route that renders the certificate, supporting both PNG and PDF, in a
    similar fashion as the template API renders its preview.

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.