Skip to content

Commit

Permalink
updates README, naming
Browse files Browse the repository at this point in the history
  • Loading branch information
CharlieIGG committed Jan 4, 2020
1 parent 79792d8 commit 3eaed6d
Show file tree
Hide file tree
Showing 19 changed files with 84 additions and 72 deletions.
12 changes: 6 additions & 6 deletions .semaphore/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ blocks:

- docker pull ${RELEASE_IMAGE_TAG}

- mkdir -p startupapp && cd startupapp
- mkdir -p evaluarium && cd evaluarium

# Generate the 'web' Dockerfile:
- echo "FROM ${RELEASE_IMAGE_TAG}" >> Dockerfile.web
Expand All @@ -40,10 +40,10 @@ blocks:
- echo 'CMD [ "rails", "release" ]' >> Dockerfile.release

# Push the images to staging:
- heroku container:push --recursive --app startupapp-staging
- heroku container:push --recursive --app evaluarium-staging

# Release the images to staging:
- heroku container:release web release --app startupapp-staging
- heroku container:release web release --app evaluarium-staging

- name: Production Deploy
task:
Expand All @@ -67,7 +67,7 @@ blocks:

- docker pull ${RELEASE_IMAGE_TAG}

- mkdir -p startupapp && cd startupapp
- mkdir -p evaluarium && cd evaluarium

# Generate the 'web' Dockerfile:
- echo "FROM ${RELEASE_IMAGE_TAG}" >> Dockerfile.web
Expand All @@ -77,7 +77,7 @@ blocks:
- echo 'CMD [ "rails", "release" ]' >> Dockerfile.release

# Push the images to production:
- heroku container:push --recursive --app startupapp-production
- heroku container:push --recursive --app evaluarium-production

# Release the images to production:
- heroku container:release web release --app startupapp-production
- heroku container:release web release --app evaluarium-production
4 changes: 2 additions & 2 deletions .semaphore/semaphore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ blocks:
# Tag & Push test image so we can use it on later blocks:
- docker-image-manager tag-and-push test

- name: "Startup Evaluation App Tests"
- name: "Evaluarium Tests"
dependencies: ["Build Test Images"]
task:
secrets:
Expand Down Expand Up @@ -88,7 +88,7 @@ blocks:

- name: End-to-End Tests
dependencies:
- "Startup Evaluation App Tests"
- "Evaluarium Tests"
task:
jobs:
# This is just a placeholder we'll have for now:
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## How to contribute to STARTUPAPP
## How to contribute to EVALUARIUM

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/charlieigg/startupapp/issues).
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/charlieigg/evaluarium/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/charlieigg/startupapp/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. Also add a `bug` tag to it.
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/charlieigg/evaluarium/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. Also add a `bug` tag to it.

#### **Are you ready to place a pull request?**

Expand All @@ -19,7 +19,7 @@

#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**

For changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of STARTUPAPP, just add a title tag of `[COSMETIC]` and assign the code reviewer.
For changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of EVALUARIUM, just add a title tag of `[COSMETIC]` and assign the code reviewer.

#### **Do you have questions about the source code?**

Expand Down
8 changes: 4 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,12 @@ CMD [ "puma" ]
ARG SOURCE_BRANCH="master"
ARG SOURCE_COMMIT="000000"
ARG BUILD_DATE="2017-09-26T16:13:26Z"
ARG IMAGE_NAME="startupapp:latest"
ARG IMAGE_NAME="evaluarium:latest"

LABEL org.label-schema.build-date=$BUILD_DATE \
org.label-schema.name="Startup Evaluation App" \
org.label-schema.description="startupapp" \
org.label-schema.vcs-url="https://github.com/charlieigg/startupapp.git" \
org.label-schema.name="Evaluarium" \
org.label-schema.description="evaluarium" \
org.label-schema.vcs-url="https://github.com/charlieigg/evaluarium.git" \
org.label-schema.vcs-ref=$SOURCE_COMMIT \
org.label-schema.schema-version="1.0.0-rc1" \
build-target="release" \
Expand Down
48 changes: 30 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# STARTUPAPP
# EVALUARIUM

![](https://github.com/CharlieIGG/startupapp/workflows/specs/badge.svg)
![](https://github.com/CharlieIGG/evaluarium/workflows/specs/badge.svg)

Startup Evaluation App. For Startup Incubators, Accelerators, Hackathons, and other kinds of public and private scenarios for evaluating startups.
Evaluating Projects is easy in a lot of cases, but when it comes down to projects where the evaluation
is rather qualitative, things get messy.

Evaluarium is an open-source, self-hosted platform for managing Projects in the context of Evaluation Programs.
It can be used for voting panels in Hackathons and/or Admission Comittes, or even to keep up with a Venture Capital portfolio.

Typical use-cases are Startup Incubators, Accelerators, Hackathons, and other such scenarios where projects get evaluated in any matter that has a degree of "qualitativeness", as opposed to projects that can be very easily normalized and analyzed in a purely numerical manner (e.g. Real Estate development).

## Table of contents

- [STARTUPAPP](#startupapp)
- [EVALUARIUM](#evaluarium)
- [Table of contents](#table-of-contents)
- [Environment URLS](#environment-urls)
- [Da team](#da-team)
- [The team](#the-team)
- [Management tools](#management-tools)
- [Development](#development)
- [Setup the project](#setup-the-project)
Expand All @@ -21,23 +27,24 @@ Startup Evaluation App. For Startup Incubators, Accelerators, Hackathons, and ot
- [TestProf](#testprof)
- [Analyzing code for issues](#analyzing-code-for-issues)
- [Deploying](#deploying)
- [Contributing](#contributing)

### Environment URLS

- **Production** - TBD
- **Staging** - TBD

### Da team
### The team

| Name | Email | Role |
| ---------------- | --------------------- | ----------- |
| Carlos I. Garcia | [email protected] | Development |
| Name | Email | Role |
| ---------------- | --------------------- | ------------------ |
| Carlos I. Garcia | [email protected] | Development, Owner |

### Management tools

You should ask for access to this tools if you don't have it already:

- [Github repo](https://github.com/charlieigg/STARTUPAPP)
- [Github repo](https://github.com/charlieigg/EVALUARIUM)
- [Pivotal tracker project](https://www.pivotaltracker.com/)
- [Client Slack](https://change-me.slack.com/)
- [Heroku](https://heroku.com)
Expand All @@ -60,14 +67,14 @@ After installing please you can follow this simple steps:
1. Clone this repository into your local machine

```bash
$ git clone [email protected]:charlieigg/startupapp.git
$ git clone [email protected]:charlieigg/evaluarium.git

```

2. Copy the `example.env` file to `.env` in the project's source directory.

```bash
$ cd startupapp
$ cd evaluarium
$ cp example.env .env
```

Expand Down Expand Up @@ -112,7 +119,7 @@ docker-compose:
$ docker-compose up
```

That command will lift every service STARTUPAPP needs, such as the `rails server`, `postgres`, and `redis`.
That command will lift every service EVALUARIUM needs, such as the `rails server`, `postgres`, and `redis`.

It may take a while before you see anything, you can follow the logs of the containers with:

Expand All @@ -134,7 +141,7 @@ This means the project is up and running.

### Stop the project

In order to stop STARTUPAPP as a whole you can run:
In order to stop EVALUARIUM as a whole you can run:

```
% plis stop
Expand All @@ -150,7 +157,7 @@ This will stop every container, but if you need to stop one in particular, you c

### Restoring the database

You probably won't be working with a blank database, so once you are able to run STARTUPAPP you can restore the database, to do it, first stop all services:
You probably won't be working with a blank database, so once you are able to run EVALUARIUM you can restore the database, to do it, first stop all services:

```
% plis stop
Expand All @@ -165,15 +172,15 @@ Then just lift up the `db` service:
The next step is to login to the database container:

```
% docker exec -ti startupapp_db_1 bash
% docker exec -ti evaluarium_db_1 bash
```

This will open up a bash session in to the database container.

Up to this point we just need to download a database dump and copy under `STARTUPAPP/backups/`, this directory is mounted on the container, so you will be able to restore it with:
Up to this point we just need to download a database dump and copy under `EVALUARIUM/backups/`, this directory is mounted on the container, so you will be able to restore it with:

```
root@a3f695b39869:/# bin/restoredb startupapp_dev db/backups/<databaseDump>
root@a3f695b39869:/# bin/restoredb evaluarium_dev db/backups/<databaseDump>
```

If you want to see how this script works, you can find it under `bin/restoredb`
Expand Down Expand Up @@ -242,3 +249,8 @@ If you have previously run the `./bin/setup` script,
you can deploy to staging and production with:
% ./bin/deploy staging
% ./bin/deploy production
## Contributing
Feel free to create forks + pull requests for this project with new features and bug-fixes.
If you're wanting to implement a functionallity that is very specific to your use case or industry, it should be added in a modular way (as an opt-in feature).
2 changes: 1 addition & 1 deletion app/views/layouts/application.html.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Startup Evaluation App</title>
<title>Evaluarium</title>
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
Expand Down
2 changes: 1 addition & 1 deletion app/views/layouts/landing.html.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Startup Evaluation App</title>
<title>Evaluarium</title>
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
Expand Down
4 changes: 2 additions & 2 deletions bin/minio-entrypoint
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
# This is a script used by the project's Docker development environment to
# setup development buckets:.

# 1: Create the 'startupapp' bucket:
mkdir -p /data/startupapp
# 1: Create the 'evaluarium' bucket:
mkdir -p /data/evaluarium

# 2: Invoke the original entrypoint:
exec /usr/bin/docker-entrypoint.sh "$@"
2 changes: 1 addition & 1 deletion bin/restoredb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# For use on the postgres container only.
# Usage:
# bin/restoredb startupapp_dev db/dumps/<your-dump-name>
# bin/restoredb evaluarium_dev db/dumps/<your-dump-name>
set -e

: ${DB_NAME:=$1}
Expand Down
32 changes: 16 additions & 16 deletions bin/setup
Original file line number Diff line number Diff line change
Expand Up @@ -35,44 +35,44 @@ chdir APP_ROOT do
system! 'bin/rails restart'
end

if heroku join --app STARTUPAPP-staging > /dev/null 2>&1; then
git remote add staging git@heroku.com:STARTUPAPP-staging.git || true
printf 'You are a collaborator on the "STARTUPAPP-staging" Heroku app
if heroku join --app EVALUARIUM-staging > /dev/null 2>&1; then
git remote add staging git@heroku.com:EVALUARIUM-staging.git || true
printf 'You are a collaborator on the "EVALUARIUM-staging" Heroku app
'
else
printf 'Ask for access to the "STARTUPAPP-staging" Heroku app
printf 'Ask for access to the "EVALUARIUM-staging" Heroku app
'
fi


if heroku join --app STARTUPAPP-production > /dev/null 2>&1; then
git remote add production git@heroku.com:STARTUPAPP-production.git || true
printf 'You are a collaborator on the "STARTUPAPP-production" Heroku app
if heroku join --app EVALUARIUM-production > /dev/null 2>&1; then
git remote add production git@heroku.com:EVALUARIUM-production.git || true
printf 'You are a collaborator on the "EVALUARIUM-production" Heroku app
'
else
printf 'Ask for access to the "STARTUPAPP-production" Heroku app
printf 'Ask for access to the "EVALUARIUM-production" Heroku app
'
fi


git config heroku.remote staging

if heroku join --app STARTUPAPP-staging > /dev/null 2>&1; then
git remote add staging git@heroku.com:STARTUPAPP-staging.git || true
printf 'You are a collaborator on the "STARTUPAPP-staging" Heroku app
if heroku join --app EVALUARIUM-staging > /dev/null 2>&1; then
git remote add staging git@heroku.com:EVALUARIUM-staging.git || true
printf 'You are a collaborator on the "EVALUARIUM-staging" Heroku app
'
else
printf 'Ask for access to the "STARTUPAPP-staging" Heroku app
printf 'Ask for access to the "EVALUARIUM-staging" Heroku app
'
fi


if heroku join --app STARTUPAPP-production > /dev/null 2>&1; then
git remote add production git@heroku.com:STARTUPAPP-production.git || true
printf 'You are a collaborator on the "STARTUPAPP-production" Heroku app
if heroku join --app EVALUARIUM-production > /dev/null 2>&1; then
git remote add production git@heroku.com:EVALUARIUM-production.git || true
printf 'You are a collaborator on the "EVALUARIUM-production" Heroku app
'
else
printf 'Ask for access to the "STARTUPAPP-production" Heroku app
printf 'Ask for access to the "EVALUARIUM-production" Heroku app
'
fi

Expand Down
4 changes: 2 additions & 2 deletions ci-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ services:
- backend
command: rspec
environment:
DATABASE_URL: postgres://postgres:3x4mpl3P455w0rd@postgres:5432/startupapp_test
DATABASE_URL: postgres://postgres:3x4mpl3P455w0rd@postgres:5432/evaluarium_test
RAILS_ENV: test
RACK_ENV: test
MAILER_HOST: localhost
Expand Down Expand Up @@ -56,7 +56,7 @@ services:
SOURCE_BRANCH: ${GIT_BRANCH}
SOURCE_COMMIT: ${GIT_SHA}
BUILD_DATE: ${BUILD_DATE}
IMAGE_NAME: "charlieigg/startupapp"
IMAGE_NAME: "charlieigg/evaluarium"
cache_from:
- ${ECR_URL}:${GIT_SHORT_SHA:-latest}
- ${ECR_URL}:builder-${GIT_SHORT_SHA:-latest}
Expand Down
2 changes: 1 addition & 1 deletion config/application.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)

module STARTUPAPP
module EVALUARIUM
class Application < Rails::Application
# don't generate RSpec tests for views and helpers
config.generators do |generator|
Expand Down
2 changes: 1 addition & 1 deletion config/cable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ test:
production:
adapter: redis
url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
channel_prefix: STARTUPAPP_production
channel_prefix: EVALUARIUM_production
4 changes: 2 additions & 2 deletions config/database.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ default: &default

development:
<<: *default
database: startupapp_development
database: evaluarium_development

# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
<<: *default
database: startupapp_test
database: evaluarium_test

# As with config/secrets.yml, you never want to store sensitive information,
# like your database password, in your source code. If your source code is
Expand Down
Loading

0 comments on commit 3eaed6d

Please sign in to comment.