RealDevSquad / RealDevSquad/website-backend
Simplify the README
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 276
- Avg merge
- 1d 26m
- Merged PRs (30d)
- 14
Description
- Config Update
Create a new file:
config/local.js. Override the required config values fromconfig/development.jsandconfig/default.jsintoconfig/local.js.
Override something from 2 files doesn't seem very beginner-friendly I guess? We could just say copy paste the whole config/development.js into config/local.js and override the client id and client secret values with your own values. That would be more helpful for any beginner
Register the application for GitHub OAuth to get the
clientIdandclientSecret. Add the callback URL ashttp://<HOSTNAME>:<PORT>/auth/github/callback
Discussion here: Link
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the README section covering configuration and GitHub OAuth, then compare config/development.js and config/default.js with the proposed config/local.js setup. Update the instructions so beginners can copy the development configuration, replace clientId and clientSecret, and set the callback URL; verify the resulting setup steps are complete and unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, javascript, nodejs
- Domain
- authentication, backend, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100