Skip to content

Commit 5c56b2d

Browse files
authored
chore: clean up repo for public release (#538)
1 parent f6a91ff commit 5c56b2d

File tree

13 files changed

+595
-14
lines changed

13 files changed

+595
-14
lines changed

.github/brand/cesium-DARK.svg

Lines changed: 42 additions & 0 deletions
Loading

.github/brand/cesium-LIGHT.svg

Lines changed: 42 additions & 0 deletions
Loading

.github/brand/safira-banner.png

135 KB
Loading

CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
[asdf-vm]: https://asdf-vm.com/
2+
3+
# 🚀 Getting Started
4+
5+
These instructions will get you a copy of the project up and running on your
6+
local machine for development and testing purposes.
7+
8+
## 📥 Prerequisites
9+
10+
The following software is required to be installed on your system:
11+
12+
- [Erlang 26+](https://www.erlang.org/downloads)
13+
- [Elixir 1.17+](https://elixir-lang.org/install.html)
14+
- [PostgreSQL 13+](https://www.postgresql.org/download/)(see [this section](#-docker) for setting up with docker)
15+
16+
We recommend using [asdf version manager][asdf-vm] to install and manage all
17+
the programming languages' requirements.
18+
19+
If you prefer to use docker, see the [section below](#-docker).
20+
21+
## 🔧 Setup
22+
23+
First, clone the repository:
24+
25+
```
26+
git clone [email protected]:cesium/safira.git
27+
cd safira
28+
```
29+
30+
Then, run the setup script to get all dependencies configured. Make sure the database is up and running.
31+
32+
```
33+
bin/setup
34+
```
35+
36+
Then you should change the `.env.dev` file as needed. Run this script again if
37+
needed.
38+
39+
## 🔨 Development
40+
41+
Start the development server and then you can visit `http://localhost:4000`
42+
from your browser.
43+
44+
```
45+
bin/server
46+
```
47+
48+
Run the tests.
49+
50+
```
51+
bin/test
52+
```
53+
54+
Lint your code.
55+
56+
```
57+
bin/lint
58+
```
59+
60+
Format your code.
61+
62+
```
63+
bin/format
64+
```
65+
66+
## 🐳 Docker
67+
68+
For data persistence this project uses a PostgreSQL database. You should have
69+
PostgreSQL up and running.
70+
71+
If you want to setup the required database using docker containers you can
72+
easily do it with [docker-compose](https://docs.docker.com/compose/install/).
73+
74+
Create and start the database containers. You should use `linux.yml` if running on Linux and `darwin.yml` if running on macOS.
75+
76+
```
77+
cp .env.dev.sample .env.dev
78+
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml up db
79+
```
80+
81+
Start the previously created containers.
82+
83+
```
84+
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml start
85+
```
86+
87+
Stop the containers.
88+
89+
```
90+
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml stop
91+
```
92+
93+
Destroy the containers and volumes created.
94+
95+
```
96+
docker-compose -f docker-compose.dev.yml -f {linux,darwin}.yml down -v
97+
```
98+
99+
## 🔗 References
100+
101+
You can use these resources to learn more about the technologies this project
102+
uses.
103+
104+
- [Getting Started with Elixir](https://elixir-lang.org/getting-started/introduction.html)
105+
- [Erlang/Elixir Syntax: A Crash Course](https://elixir-lang.org/crash-course.html)
106+
- [Elixir School Course](https://elixirschool.com/en/)
107+
- [Phoenix Guides Overview](https://hexdocs.pm/phoenix/overview.html)
108+
- [Phoenix Documentation](https://hexdocs.pm/phoenix)
109+
- [Ecto Documentation](https://hexdocs.pm/ecto)

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 CeSIUM - Centro de Estudantes de Eng. Informática da UMinho
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)