Skip to content

Commit 4b1bf8c

Browse files
committed
Add CoC, mv License file, add local dev instructions to the README
1 parent 60e459a commit 4b1bf8c

File tree

5 files changed

+119
-4
lines changed

5 files changed

+119
-4
lines changed

.env.example

-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@ CELERY_BROKER_URL=redis://redis:6379/0
33
C_FORCE_ROOT=true
44
DB_CYPHER_KEY=whatever
55
SECRET_KEY=pleasechangethissecretkey
6-
7-

CODE_OF_CONDUCT.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq
77+

LICENSE LICENSE.md

File renamed without changes.

Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
backend/install: .env
2-
TMPDIR=/private$$TMPDIR docker-compose up -d
2+
docker-compose up -d
33
docker-compose exec backend ./manage.py migrate
44
docker-compose exec backend ./manage.py createcachetable
55

66
backend/start:
7-
TMPDIR=/private$$TMPDIR docker-compose up
7+
docker-compose up
88

99
backend/migrate:
1010
docker-compose exec backend ./manage.py migrate

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,46 @@ You will need to provide your credit card details to Heroku, but you will be und
4040

4141
Full documentation for Falco lives on the [docs website](https://getfal.co).
4242

43+
## Local development
44+
45+
### First installation
46+
47+
- Clone the repository:
48+
```bash
49+
git clone [email protected]:theodo/falco.git
50+
```
51+
- Move to the `falco` directory:
52+
```bash
53+
cd falco
54+
```
55+
- Install the backend and the frontend:
56+
```bash
57+
make install
58+
```
59+
- Start the backend:
60+
```bash
61+
make backend/start
62+
```
63+
- Populate the database with fixtures:
64+
```bash
65+
make fixtures/load
66+
```
67+
- Edit the .env file: replace the initial SECRET_KEY with a random string
68+
69+
### To (re)start the app
70+
71+
- Start the backend:
72+
```bash
73+
make backend/start
74+
```
75+
- Start the frontend:
76+
77+
```bash
78+
make frontend/start
79+
```
80+
81+
The project should now be running at [localhost:3000](http://localhost:3000).
82+
4383
## Contributors ✨
4484

4585
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)