force-orange-2022/README.md

Paris est Ludique!'s Intranet

This project host the source code for Force Orange, the intranet used by the volunteers of the french assocication Paris est Ludique! It is built from the boilerplate React Cool Starter, on top of React, Redux, React Router, Express, Yarn, webpack and Babel.

Contributing

Onboarding

This project is open to contribution, but you will likely need to be in touch with us in order to collaborate efficiently. Contact Paris Est Ludique via our official Website then join the Discord. You will need to get:

• Access to a database sample to place in ./access/dbToLoad.json
• Access to our Trello Issue trackerd

Requirements

• An account on GitHub
• git
• node >= 12.0
• npm >= 6.0
• On MacOS, HomeBrew is recommanded
• An IDE of your choice. We suggests:
  • Atom with TypeScript plugin
  • Visual Studio Code
  • Webstorm 2018.1
  • Sublime Text with Typescript-Sublime-Plugin

Setup

Using a terminal:

# Clone this repository on your computer
git clone https://github.com/forceoranj/intranet.git
cd intranet

# Install dependencies using YARN
npm install --legacy-peer-deps
brew install corepack # If not included in your npm
corepack enable
yarn

# Include the database
mv ~/Downloads/database-sample.json ./access/dbToLoad.json

# Start your local server
yarn dev  # Build, hosts, and hot reload saved modifications

Now the app should be serving at http://localhost:3000.

Contribution rules

We stick to the GitHub Flow workflow

• Commiting to the main branch is forbidden. Make use of topic branches to change code.
• PR names should follow the Conventional Commit (fix(#x), feat(#y), refactor(#z), …)
• PR should relate to an issue on our Issue Tracker, either our Trello board or this project one.
• You can fork the repository on your space and PR from there, but this is not mandatory.

Contributors ✨

Thanks goes to these people (emoji key):

pikiou 💻 📖 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!