Giter Club home page Giter Club logo

startup-fairy's Introduction

StartupFairy

IMD 4

Apiary Docs Travis

Setup

You'll need

  1. Run docker-compose up -d.
  2. Do docker-compose ps to see all your availble containers and the status of them.
  3. Once startupfairy the app is up and running, run docker exec -it startupfairy bash. You'll be inside the startupfairy container.
  4. Run bower install --allow-root - installs your CSS.
  5. Run make db

You will only need to do steps 3 & 4 if you are creating the containers for the first time or if you're missing the app/static/bower_components directory.

Steps 5&6 must be done each time you recreate the containers.

The database was intended to contain all the values already, but for some reason the values are not held despite commiting any changes made to the database. For now this is the necessary workaround in order to get the database working locally.

Development

You'll see the app at localhost. There is parity between the content on your local machine and the content inside the docker container.

If you shut down your computer/Docker machine, the next time you boot up docker, you will need to run docker-compose start in order to start up all the services (postgres and app) again.

Deployment

Same steps as development.

Models

  • Company

    • Name
    • Summary
    • Employees
    • City
    • Investors
    • Twitter
    • Website
  • Financial Org

    • Name
    • Summary
    • City
    • Companies invested in
    • Twitter
    • Website
  • People

    • Name
    • Bio
    • City
    • Company
    • Role
    • Twitter
  • City

    • Name
    • State
    • Country
    • Companies
    • Financial Orgs
    • People

UML Diagram

http://yuml.me/96b7f61e

startup-fairy's People

Contributors

addykim avatar marktheperson avatar ilinum avatar eugenern avatar summergirl21 avatar cameronreynoldson avatar ajrator avatar

Stargazers

 avatar  avatar

Watchers

James Cloos avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

ajrator addykim

startup-fairy's Issues

Create technical report using GitHub Wiki

Requirements:

Section

  • Feature

Title

  • The group name.
  • The group members.

Introduction
What is the problem?
What are the use cases?

Design

  • RESTful API

Tools

  • front-end
  • back-end
  • embedding-media services

Hosting

  • How do you set up the Digital Ocean or AWS server?

Other

  • Proof-read your report. Get another group to read it. Read it aloud.

Create diagrams with captions.
Create sections and subsections effectively.

Create about page

description of the site, its purpose, its intended users
the group name
the group members

for each member:
name
photo
bio
major responsibilities
no. of commits
no. of issues
no. of unit tests

stats:
total no. of commits
total no. of issues
total no. of unit tests
a link to the Apiary API
a link to the GitHub Issue Tracker
a link to the GitHub Repo
a link to the GitHub Wiki

data:
links to the data sources
description of how each was scraped

tools:
tools used
describe their use
special focus on optional tools that were not required

Create page for model 4

for each model, a page that contains a
table of all of the instances of that model
with at least five columns of attributes of that model
with the ability to sort the table using any of the columns
in ascending or descending order and
with links to those instances
right now with only three rows
but eventually with many rows and pagination

Setup flask backend

Create a set of static HTML pages for three crises, three organizations, and three people that displays all of the data collected.
The pages must be served by using Flask to embed the static content into the HTML.

Create page for model 1

for each model, a page that contains a
table of all of the instances of that model
with at least five columns of attributes of that model
with the ability to sort the table using any of the columns
in ascending or descending order and
with links to those instances
right now with only three rows
but eventually with many rows and pagination

Make changes to splash page

Add more content? Change the links? Do the nav buttons match the links on the splash page
Close if there is no changes need to be made

Add category picker

Each model (or "category") has a table associated it. On the category page, we ant to be able to select a category and display the appropriate content.

Create UML class diagram

Create a UML class diagram of the models using yUML
The diagram needs to show data members, methods, associations and multiplicity between the models.

Run tests on models

Write unit tests in tests.py that test corner cases and failure cases until you have an average of 3 tests for each function/method, confirm the expected failures, and add, commit, and push to the PUBLIC code repo.

Create page for model 3

for each model, a page that contains a
table of all of the instances of that model
with at least five columns of attributes of that model
with the ability to sort the table using any of the columns
in ascending or descending order and
with links to those instances
right now with only three rows
but eventually with many rows and pagination

Get namecheap domain

Blocked by project proposal, unsure if it is also necessary in phase 1 anyways

Create page for model 2

for each model, a page that contains a
table of all of the instances of that model
with at least five columns of attributes of that model
with the ability to sort the table using any of the columns
in ascending or descending order and
with links to those instances
right now with only three rows
but eventually with many rows and pagination

Configure tables

columns by category
add clickable links to show details
display each item in a cell if it is a list properly (doesn't show commas where needed)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.