To make the local development of S42 easier, we use devcontainers on vscode.
The strategy is to scope all development on a container to prevent any conflict with your machine setup or permission on your machine (If you work on the project at school for example).
The devcontainer allow us to have a full permission workspace and a developement process similar for everyone across the globe, freezed in the time.
Inside the devcontainers, the database, rabbitmq and others dependencies is automatically setup and linked with the app. You dont need to do boring env setup or docker-compose, devcontainers already do that for you. You needs to do some edit to your env config to add credentials to external services like Github, Discord, 42, ...
Like say before, you needs to add some credentials listed on the file .devcontainer/.env file (this file is hard ignored but be careful to never force add this file).
DO NOT GIT ADD THE .devcontainer/.env FILE. NEVER PUSH YOUR CREDENTIALS ON ANY COMMITS
⚠️ After setup your credentials on the file, you need to rebuild the container to apply it on the devcontainer.To do that : Command Palette (⇧⌘P) and execute
Dev Containers: Rebuild Container
To develop on S42, you need to have your OAuth2 applications with her credentials. Each OAuth2 provide to you an ID and a SECRET. In the next sub section, we give you the endpoint for each provider.
Endpoint: https://profile.intra.42.fr/oauth/applications/new
Environment keys: FORTY_TWO_ID and FORTY_TWO_SECRET
Callback Url to provide: http://localhost:3000/api/auth/callback/42-school
Endpoint: https://github.com/settings/applications/new
Environment keys: GITHUB_ID and GITHUB_SECRET
Callback Url to provide: http://localhost:3000/api/auth/callback/github
Endpoint: https://discord.com/developers/applications
Environment keys: DISCORD_ID and DISCORD_SECRET
Callback Url to provide: http://localhost:3000/api/auth/callback/discord
Discord bot needs to have a token generated and given on DISCORD_TOKEN key. To generate your bot token, see bot section on your discord developer application page.
This is simple, just copy the file config/stud42.example.yaml and rename the copy as config/stud42.yaml !
To start using the devcontainer, you need to populate your database. You can do that with the tasks Populate DB with campus and Populate DB with active locations (Paris) (see #Tasks to know how to launch task in vscode).
To launch and debug services, apps or interface, we have already add all Debugger profiles for each services.
All services except the interface actually can be run separately without dependencies on other service. So you can juste start the debug profile for the service you want to edit with the Debugger of VSCode.
For interface, run the api and the auth service on your terminal and start the interface with the debugger do the coffee for you. You can start all at once with the #Tasks Start Project
VSCode have incredible feature called Tasks. Any mendatory operation of the project can be performed with tasks (start api, lint, code, generata code, ...).
To execute task : Command Palette (⇧⌘P) and execute Tasks: Run Task, select which one you want to run and a dedicated terminal will open soon