Code Monkey home page Code Monkey logo

alu-map's People

Contributors

dirac156 avatar freedisch avatar kehindebello avatar nirajpdn avatar perfectizihirwe avatar pragyaasapkota avatar revortni avatar santigio avatar zainbinfurqan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

alu-map's Issues

server: create a common model

A common is identified by a name, the number of rooms, the number of floors, the number of pods, and the closest common.

Add data validation

client + documentation: come up with a simple ui template

Components:

  • Search engine field where some can look for a room.
  • A Result field when data is found or not.
  • Admin authentication.
  • Form to add a new room: Refer to ALU rooms (Floor, common, name, ...)
  • Form to add a new common.

Add the link to the prototype on the README.md file.
Add the section containing the prototype file into the table of content.

create express route and controller to look for a room.

Create a route under /search?room={name of room}

HTTP Method: GET Request

Return:

  • status code: 200 (success) data: [Rooms...]
  • 200 (success) data: [] message: "Room not found"
  • On failure: status code: 500 messages: Internal server error

Add a voice detector in the client project

Steps:

  • On the service folder create a new file called speechRecognition.jsx
  • Add functionalities.

Alternative:

  • create a hook called useSpeechRecognition

Add a command detector that identifies a key used by the user to activate the voice detector.

The key should be set by the user (Future feature)

Add a logger on the server.

Hint: Think of morgan and other loggers.

We should be able to use it when an error occurs as well.

For example Logger.error(statusCode?, path?, error, message?)

server: create a room model

A room is defined by a name, common_name, floor, capacity, longitude, and latitude.

add data validation:

  • name: should be among one of the African countries and this is unique.
  • floor: an integer value between 0 - 2
  • capacity: integer value
  • longitude: string
  • latitude: string

React APP Dockerfile

Add a docker file and configure docker to run on PORT 3000.

  • create a build version of the react application.
  • run the build version of the application with Caddy or Nginx Server.

Documentation: Add a new file called apiDocs

  • Add a description of the file: This doc will help the front end knows about the endpoint and data returned from the backend. It will also help the backend developer knows what is sent from the front end.
    This should be formulated in a proper way.

  • Add a table with columns: endPoint, body, params, response, others (Authorization required, ...)

  • Add the link to the file on README.md with permission for everyone to comment for now.

  • The section leading to the API docs link should be added to the table of content as API documentation.

Landing page/Documentation for new contributors

This page will help new contributors know how to get started with this project instead of landing on the default React page. It also has links to necessary tools like Docker, Hyper-V and Issues section of this repo. I need access to push it @Dirac156

Screenshot_20221021_115410

Setup docker image for mongodb and configure mongoose.

Steps:

Create an appconfig.js file under config folder.
export object appconfig file (collection of all configurations).

The appconfig file will contain app config, database config, ...

const appconfigfile = { db: { uri: MONGO_DB_URI (from .env || docker_img) } }

use the URI to connect to the database.
log mongodb events.

Need a contribution.md file

The file will contain guidelines and best practices we should follow for the pull request to be accepted and merged into the main project.

NodeJS Dockerfile

Create a docker file and add some simple configurations to run the server on a docker container.

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.