Code Monkey home page Code Monkey logo

commenting's Introduction

Commenting system

This is a small commenting system where we can comment using different frontend solutions.

Commitizen

This is a commitizen friendly repo. In order to commit, use:

cz

This way, all commit messages are going to have the same format. Allowing in the future rely in an automated way of generating changelogs, for example.

Folder and project structure

  • html-template: this folder/project houses the initial HTML template draft. The goal is to extract some CSS values from the Figma design. Published at: https://commenting-template.tuliofaria.dev/
  • backend: this folder/project houses the backend code. It´s a NodeJS, ExpressJS, Knex, Bookshelf.js with PostgreSQL as database (to make it simpler to deploy to Heroku). Published at: https://commenting-test.herokuapp.com/
  • frontend-v1: first version of the frontend created using Vanilla Javascript. Published at: https://commenting-frontend-v1.tuliofaria.dev/. Copy one user id from the list of users, paste in the input field and click Signin.
  • frontend-v2: second version of the frontend created using React. Published at: https://commenting-frontend-v2.tuliofaria.dev/. It uses NextJS as platform and besides having a better UX it alse integrates with Socket.io to receive realtime updates.

Sign-in:

In order to see the available users in this endpoint (this is relevant for frontend-v1 in order to get a user id to sign-in):

https://commenting-test.herokuapp.com/users

  • Additionally, you can also create a new user with a POST request to the same endpoint, sending a json body like this:
{
	"name": "Tulio Faria"
}

Author

Tulio Faria

commenting's People

Contributors

tuliofaria avatar

Watchers

 avatar  avatar  avatar

commenting's Issues

add and configure knex and bookshelf.js to the project

Add and configure knex and bookshelf.js to the project.

The definition of done:

  • add knex and bookshelf to the project as dependency
  • create a lib/bookshelf.ts with the initialization of bookshelf.
  • this lib should load DB connection settings from environment variables (locally using .env file)
  • update .env file to reflect these env variables needs

Organize repository to house all project variations + needs

  • Create initial readme.md
  • Prepare commitizen in order to standardize commits comments on this repository
  • Initial organization goal:
  • a) html-template: just the HTML + CSS conception initial coded (the goal is to have abstracted some CSS selectors / attributes)
  • b) backend: API + database needs
  • c) frontend-v1: frontend in vanilla javascript
  • d) frontend-v1.1: frontend in jQuery
  • e) frontend-v2: nextjs + react + css.modules

bootstrap backend project

The goal is to have the initial version of the backend using:

  • ExpressJS
  • Typescript

It´s important to have in place the scripts for building and starting the project.

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.