Skip to content

Feat/security order clean#238

Open
SimonIsCoding wants to merge 2 commits into
d-r-e:mainfrom
SimonIsCoding:feat/security-order-clean
Open

Feat/security order clean#238
SimonIsCoding wants to merge 2 commits into
d-r-e:mainfrom
SimonIsCoding:feat/security-order-clean

Conversation

@SimonIsCoding

Copy link
Copy Markdown

I struggled to make it work on my local machine. I was discovering how 42 API was working. So I wrote an explicit readme.

Summary

This PR only updates documentation to make local setup easier for new contributors.

What changed

  • Added a short project-purpose paragraph at the top of README.
  • Added a collapsible section: Running RNCP Planner locally.
  • Included clear local setup steps:
    • create 42 OAuth application
    • set callback URL to http://localhost:3000/auth/callback/42
    • configure flask/.env with the project variables
    • run with docker compose
  • Removed redundant/less beginner-friendly build instructions from README.
  • Added/kept dedicated setup doc in docs/running.md.

Why

New contributors (especially first-time open-source contributors) had difficulty understanding how to run the project locally.
This change makes onboarding faster and reduces setup confusion.

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

Successfully merging this pull request may close these issues.

1 participant