backflush / rocket.q

It's an application that users send a question to the admin and he can reply to it.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rocket.q

Preview-Screen

If you want to take a look on all screens of the application, they are here.

About this project

The idea of the application is:

"Create an answer/ask questions to an admin reply it."

Why?

This project is part of my personal portfolio, it was developed during the NLW Together week, provided by Rocketseat. I'll be happy if you could send me any feedback about the project, code, structure or anything that you can report that could make me better as a developer!

Reach me at: bwesleysouza@gmail.com

Connect with me at LinkedIn.

And you can use this project as you wish!

Some Observations about this App

  • The project isn't finished! I intend to continue it!
  • It's not responsive to mobile versions.
  • If the design doesn't display well, try to zoom out, some screens probably won't work well.

Functionalities

  • You can create as many classes as you want.
  • You can share the class' id to your friends.
  • There's not a login method, you are anonymous.

Getting started

Prerequisites

To run this project in the development mode, you'll need to have NodeJS that can be found here.

Installing

Cloning the Repository

$ git clone git@github.com:SouzaWesley/rocket.q.git

$ cd rocket.q

Installation dependencies

$ yarn install

or

$ npm install

Creating a databse

After the download run, so you'll be creating the database. You can configurate the folder where the file will be created in config.js.

$ npm run init-db

Running

With all dependencies installed, the database created and the environment properly configured, you can now run the application:

$ npm run dev
$ yarn dev

The project will be locate at the port localhost:3000

Build with

  • Express - Complements NodeJS with some web application features
  • Nodemon - Reloads the application
  • Sqlite3 - Used to create the database
  • EJS - Used to let JavaScript's code in HTML

Contribuing

It was developed by me during the NLW Together, my tutor was Jakeliny Gracielly. I'll be glad to receive any feedback about something that a I need to redo. And if you have any question....

Reach me at: bwesleysouza@gmail.com

or

Try it: LinkedIn

Thank you!

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

It's an application that users send a question to the admin and he can reply to it.

License:MIT License


Languages

Language:EJS 35.1%Language:CSS 34.7%Language:JavaScript 30.2%