Giter Club home page Giter Club logo

embyes's Introduction

Embyes

repo-size-badge license-badge stars-badge activity-badge

Create your custom Open Graph Embed

Table of Contents

  1. General info
  2. Features
  3. Installing
  4. Configuring
  5. Running
  6. License
  7. Notes

General info

This project was done for learning and creative purposes. I just wanted to create a full-stack app with docker.

Features

  • Backend

    • Creating a new row with data in the database
    • Deleting a row when it expired
    • Showing data from the database
  • Frontend

    • Simple form with picocss
    • Calling the API to create the row in DB

Installing

$ git clone https://github.com/Zielin0/embyes.git

$ cd embyes

Configuring

  • Database .env file

    $ cp .env.example .env

    Change the POSTGRES_PASSWORD to your password.

  • Website .env file

    $ cp website/.env.example website/.env

    If you wish to use a different URL than the default just change it in the website/.env file.

Running

You will need the docker for this.

If you are running for the first time:

$ docker compose up -d --build

If you want to close the docker containers and keep data from the database run the following:

$ ./dump_db.bat && docker compose down

If you want to run again and restore the database just do:

$ docker compose up -d && ./restore_db.bat

You will need ngork if you want to test it.

Run ngrok with http method on port 6969.

Open another terminal window and run:

$ ngrok http 6969

Copy the URL from ngrok and paste it to website/.env.

Now visit 127.0.0.1:8080 and create a test embed.

License

This project is under the MIT License.

Notes

If docker compose is not working for you then try docker-compose

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.