Backend code for BugTrackr

Table of Content

1. What is this?
2. Getting started
• Requirements
• Installation
3. License

What is this?

BugTracker-backend is the backend code written for our mini-project of semester 6. It is written in NodeJS and uses ExpressJS as the framework. It uses MongoDB as the database and Mongoose as the ODM. JWT is used for authentication and authorization. Being REST APIs, it can be used with any frontend framework of your choice.

Getting Started

This section will cover what you need to setup BugTrackr-backend locally.

Requirements

• Yarn (or npm)
• Postman (or any other API testing tool)
• MongoDB (or MongoDB Atlas)

Setting up locally

Create a mongoDB database and add the connection string to the default.json file in the config directory.

The connection string would look something like this := if you get an error with wails, run wails doctor.

{
  "db": "mongodb+srv://<username>:<password>@cluster0.w2efo32.mongodb.net/?retryWrites=true&w=majority"
}

Clone the Repository:

git clone https://github.com/Athul0491/BugTrackr-backend.git

Navigate to the Project Directory:

cd BugTrackr-backend

Run BugTrackr-backend in dev mode:

yarn start

This will run the backend on port 5000. You can change this in the index.js file.

License

This project is licensed under the MIT License, making it open and accessible for everyone.