Code Monkey home page Code Monkey logo

tech-companies's Introduction

Task 7

Introduction

This task was assigned to me by devCareer as a part of my work. The objective of this work is to carry out a CRUD operation that enables users to CREATE, READ, UPDATE, and DELETE information about IT companies.

Installation Guide

  • Clone this repository here.
  • The main branch is the most stable branch at any given time, ensure you're working from it.
  • Run npm install to install all dependencies
  • You can work with your locally installed MongoDB. Do configure to your choice in the application entry file.
  • Create an .env file in your project root folder and add your variables. See .env.example for assistance.

Usage

  • Run npm watch:dev to start the application.
  • Connect to the API using Postman on port 8081.

API Endpoints

HTTP Verbs Endpoints Action
GET /api/v1/explore To get all available companies on the platform
GET /api/v1/explore/:companyId To get specific company by ID
POST /api/v1/new To add a new company
PATCH /api/v1/update/:companyId To update company information by ID
GET /api/v1/remove To retrieve a company information

Technologies Used

  • NodeJS This is a cross-platform runtime environment built on Chrome's V8 JavaScript engine used in running JavaScript codes on the server. It allows for installation and managing of dependencies and communication with databases.
  • ExpressJS This is a NodeJS web application framework.
  • MongoDB This is a free open source NOSQL document database with scalability and flexibility. Data are stored in flexible JSON-like documents.
  • Mongoose ODM This makes it easy to write MongoDB validation by providing a straight-forward, schema-based solution to model to application data.

Author

License

This project is available for use under the MIT License.

tech-companies's People

Contributors

tjanayo avatar tijanayo avatar

Watchers

 avatar

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.