Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Backend Start Script and Add Local Development Documentation #15

Open
5 tasks
aryasoni98 opened this issue Feb 6, 2025 · 2 comments
Open
5 tasks
Assignees

Comments

@aryasoni98
Copy link

Issue Description

The backend service currently lacks a proper start script in package.json and the local development setup needs better documentation.

Current Behavior

  • No start script in backend's package.json

  • Running npm start in backend directory results in error:

  • Local development setup instructions are unclear

Proposed Changes

  1. Add start scripts to backend/package.json:

    "scripts": {
      "start": "babel-node src/server.js",
      "dev": "nodemon --exec babel-node src/server.js"
    }
  2. Add required dev dependencies:

    "devDependencies": {
      "@babel/node": "^7.x.x",
      "nodemon": "^2.x.x"
    }
  3. Update README.md with:

    • Clear environment setup instructions
    • Development prerequisites
    • Step-by-step local development guide
    • Troubleshooting section

Environment

  • Node.js version: LTS
  • OS: Cross-platform (MacOS, Linux, Windows)
  • Package Manager: npm

Additional Context

This will improve the developer experience and make it easier for new contributors to get started with the project.

Checklist

  • Update backend/package.json
  • Add new dev dependencies
  • Update README.md
  • Test changes on different platforms
  • Update documentation
@aryasoni98
Copy link
Author

@Monokaix Could you please assign me this issue? I'd love to start contributing to it.

@Monokaix
Copy link
Member

Monokaix commented Feb 7, 2025

Welcome!
/assign @aryasoni98

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants