Giter Club home page Giter Club logo

marketgeek-server's Introduction

MarketGeek Server

This repository contains all project files to run the backend server for the web version.

Configure the API Server

You find most settings for the API server in the environment file located in the root directory of the project. You will need to set up a MongoDB instance on your local machine (default port) or host an instance in the cloud and point the application to the URI of that server.

Try the API Test Program

You can use the included test program as a playground to use all the functionality of this API without having to call the endpoints directly.

Open the URL /api/v1/test in your browser and you will see a webpage that allows you to use every feature. You can also use this tool for development purposes but it won't be available on any release server for security purposes.

Use the API

You don't need an API key as of right now. This feature will be implemented in the next update, and you will receive the details for a development test server that can be accessed from anywhere shortly after.

You can send POST requests to the following endpoints:

  • /api/v1/users

    This endpoint returns a JSON object of the users that are currently in the database. It doesn't require any arguments.

  • /api/v1/user/create

    Use this endpoint to create a new user in the database. It requires three POST- parameters. Provide a String for email, password (will be hashed), and name (full name).

  • /api/v1/user/delete

    In order to delete an account from the database, use this endpoint with the email address (email) as its only argument. Please be cautious when using this API.

  • /api/v1/user/get

    This API will return a user object. It requires an email address (email).

  • /api/v1/user/auth

    Use this endpoint to authenticate a user. It requires two parameters: an email address (email) and a password (password), both strings. The password will be hashed on the server using Bcrypt and doesn't need to be encrypted when using this API.

marketgeek-server's People

Contributors

jjlange avatar

Stargazers

NASA avatar Christian Gauthier avatar Benedict Grey avatar  avatar

Watchers

NASA avatar  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.