Skip to content
Alexandre T edited this page Dec 13, 2018 · 13 revisions

Welcome to the Portail des élèves wiki!

You can find some informations in this wiki about some tips and tricks found by people before you.

Don't forget to add yourself in the fixtures (it'll be the occasion to read the fixtures page so as to take place in the great family of people who made this project live 👨‍👩‍👧‍👦).

This wiki is still under construction, feel free to add any content you deem worthy 📚

Overall structure

If you're new to web development, it may be useful to spend some time learning basics before diving right into this project !

Here is what you need to know about the overall frameworks, libraries, and technologies used

  • The backend will be powered by Django. It's a Python web framework that can be used on its own, but we'll only use it as a backend : it will handle all requests to the database thanks to the models you define.

  • The frontend will be powered by Angular. It's a framework written in TypeScript (JavaScript with additions) and enables to build highly dynamic websites (allowing for example to update some parts of the web page without reloading it entirely). We'll use it to render the web pages with the data provided by the Django backend.

  • The link between the backend and the frontend will be made by a REST API, thanks to Django REST framework. The backend will receive HTML requests (get/post/put/delete) and return a formatted file with all the required information. For example, for a user profile request it will return the user's name, email adress, profile picture url, etc. This information is then used by the frontend to render the web page.

You'll find more information and tutorials on the official websites, and Mozilla also has a good tutorial for Django : https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django.

Other useful tools

If you don't know what git is, you might want to have a look here for an introduction, here for an explanation of the terms, and here for a recap of important commands. And mind the distinction with GitHub !

If you don't know what IDE to use, PyCharm is a good choice (the license is free for students).