-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #74 from CaptainFact/staging
Release 0.8.0 - Minor bug fixes, host image on DockerHub and add dev configs for 0.8 API
- Loading branch information
Showing
19 changed files
with
101 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,9 @@ | ||
.git | ||
.gitignore | ||
.gitlab-ci.yml | ||
.idea | ||
node_modules | ||
public | ||
|
||
rel/dev* | ||
Dockerfile | ||
README.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,31 +41,39 @@ comment on these tasks directly. | |
|
||
#### Starting the API | ||
|
||
Starting the API is mandatory if you want to work on the debate platform, but you can skip this step | ||
if you're just planning to translate some part of the interface or to work on help pages. | ||
|
||
The quickest way to get the API running locally is by using its Docker image. This image | ||
The quickest way to get the API running locally is by using Docker. This image | ||
is currently stored on a private registry, and though we're planning to release it soon you can | ||
contact us if you want to start working on this today. | ||
contact us if you want to start working on this today and we'll invite you. | ||
|
||
If you don't have it, install Docker: | ||
|
||
A script will help you getting this API up and running (you must have docker installed): | ||
```bash | ||
$ curl -fsSL get.docker.com -o get-docker.sh | ||
$ sudo sh get-docker.sh | ||
``` | ||
|
||
A script will then help you getting this API up and running: | ||
Just execute `./rel/run_dev_docker_api.sh` from project's root, follow the instructions and you'll end up with | ||
an Elixir console bind to the API and listening on port 4000(HTTP) + 4001(HTTPS). | ||
|
||
Here are some useful commands you may type in: | ||
```elixir | ||
# Get current API version (also available in browser at localhost:4000) | ||
iex> :application.get_key :captain_fact, :vsn | ||
# {:ok, '0.6.1'} | ||
|
||
iex> CaptainFact.Application.version | ||
"0.7.7" | ||
# This image ships with a factory to quickly create users, without worriying about invitations and emails | ||
iex> CaptainFact.Factory.insert :user | ||
iex> DB.Factory.insert :user | ||
# %CaptainFact.Accounts.User{ | ||
# ... | ||
# email: "[email protected]", <- Use this email to connect. Password is "password" | ||
# ....} | ||
# You can also set some properties directly, like: | ||
iex> CaptainFact.Factory.insert :user, %{reputation: 5000, email: "[email protected]"} | ||
# You can also set properties directly, like: | ||
iex> DB.Factory.insert :user, %{reputation: 5000, email: "[email protected]"} | ||
|
||
# If you need a full video with sources, speakers comments and all the goods, you can run the | ||
# following command. It may take some time to run (30s-1min) cause it must fetch the speakers | ||
# pictures from wikimedia. | ||
iex> List.first(c(Path.join(:code.priv_dir(:captain_fact), "demos/demo_fr.ex"))).init_and_run | ||
|
||
# Remove all videos | ||
iex> CaptainFact.Repo.delete_all CaptainFact.Videos.Video | ||
|
@@ -76,47 +84,3 @@ iex> CaptainFact.Repo.delete_all CaptainFact.Videos.Video | |
To start the frontend just run `npm install` to install dependencies then `npm start` and you'll | ||
be able to access the site at [localhost:3333](http://localhost:3333). | ||
A default account should have been created for you with email=`[email protected]` and password=`password`. | ||
|
||
### Code style | ||
|
||
*TODO: code style and conventions* | ||
|
||
# Conduct | ||
|
||
We are committed to providing a friendly, safe and welcoming environment for | ||
all, regardless of gender, sexual orientation, disability, ethnicity, religion, | ||
or similar personal characteristic. | ||
|
||
On IRC, please avoid using overtly sexual nicknames or other nicknames that | ||
might detract from a friendly, safe and welcoming environment for all. | ||
|
||
Please be kind and courteous. There's no need to be mean or rude. | ||
Respect that people have differences of opinion and that every design or | ||
implementation choice carries a trade-off and numerous costs. There is seldom | ||
a right answer, merely an optimal answer given a set of values and | ||
circumstances. | ||
|
||
Please keep unstructured critique to a minimum. If you have solid ideas you | ||
want to experiment with, make a fork and see how it works. | ||
|
||
We will exclude you from interaction if you insult, demean or harass anyone. | ||
That is not welcome behaviour. We interpret the term "harassment" as | ||
including the definition in the | ||
[Citizen Code of Conduct](http://citizencodeofconduct.org/); | ||
if you have any lack of clarity about what might be included in that concept, | ||
please read their definition. In particular, we don't tolerate behavior that | ||
excludes people in socially marginalized groups. | ||
|
||
Private harassment is also unacceptable. No matter who you are, if you feel | ||
you have been or are being harassed or made uncomfortable by a community | ||
member, please contact one of the channel ops or any of the | ||
[CaptainFact](https://github.com/CaptainFact) core team | ||
immediately. Whether you're a regular contributor or a newcomer, we care about | ||
making this community a safe place for you and we've got your back. | ||
|
||
Likewise any spamming, trolling, flaming, baiting or other attention-stealing | ||
behaviour is not welcome. | ||
|
||
# Frequently Asked Questions | ||
|
||
*TODO* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
Oops, something went wrong.