Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 1.61 KB

README.md

File metadata and controls

73 lines (42 loc) · 1.61 KB

Ecstacy API

The server side code of Ecstacy, a secure e-commerce web application developed primarily to facilitate buying and selling of products between users.

Getting Started

To run the Ecstacy API locally,

Clone this repo

git clone https://github.com/ecstacy-fcs/api.git

Go to the project directory and install dependencies

cd api
npm install

You will need to add the following environment variables to your .env file.

PORT

DATABASE_URL

CLIENT_ORIGIN

API_BASE_URL

SESSION_NAME

COOKIE_SECRET

UPLOADS_ROOT

SENDGRID_API_KEY

RAZORPAY_API_TEST_USERNAME

RAZORPAY_API_TEST_PASSWORD

RAZORPAY_API_LIVE_USERNAME

RAZORPAY_API_LIVE_PASSWORD

Refer to .env.example for example environment variables.

Run the development server

npm run dev

Open http://localhost:5000 with your browser to a message that the API is listening at port 5000.

The app uses Razorpay in test mode. To use the live mode, change all instances of RAZORPAY_API_TEST_USERNAME to RAZORPAY_API_LIVE_USERNAME and RAZORPAY_API_TEST_PASSWORD to RAZORPAY_API_LIVE_PASSWORD.

To run the Ecstacy web application (both API and client) locally, and for more extensive documentation, refer to the complete guide here.

Authors

This project was developed by MDMA

License

MIT