Botlbot

Botlbot is a web application that allows Twitter users to build their own bots that will generate tweets for them based on templates they've created (from news articles from NYTimes and trending twitter topics, to random wordlists and emojis). From a list of tweets generated, a user can post, edit, schedule, or trash the tweet.

Team

• Product Owner: Nathaniel Edwards
• Scrum Master: Daniel Tunon
• Development Team Members: Trini Le

Table of Contents

1. Example / Usage
2. Requirements
3. Development
   1. Installation
4. Architecture

• High Level Architecture
• Database Schema

1. API Endpoints
2. Contributing
3. Roadmap
4. Licensing

Usage

Requirements

• Node 4.4.2
• Express 4.13.4
• Redis 3.0.7
• Postgresql 9.5.2
• ReactJs 15.0.2
• React-Redux 4.4.5
• Webpack 1.13.0
• Passport 0.3.2
• Babel-Core 6.7.7
• Mocha 2.4.5

Development

File Structure

See FILE-STRUCTURE.md

Installation

From within the root directory:

Install Dependencies

npm install

Run Webpack Build

npm run build

Run servers

• Run file server

node server/server.js

• Run Template Services

node templateServices/server.js

• Run Postgres SQL server

psql

• Run Redis Server to use redis-conf file

redis-server server/redis/redis-conf

Create DATABASE in Postgres

• In postgres create databases botlbot_db and botlbot_db_test;

  CREATE DATABASE boltbot_db; 
  CREATE DATABASE botlbot_db_test;

• From within root directory, run migrations to create tables.

knex migrate: latest 

OR

node_modules/.bin/knex migrate:latest

Architecture

High Level Architecture

Database Schema

API

For API Documentation, please see the API-ENDPOINTS.md file

Roadmap

View the project roadmap here

Contributing

Contributors

• Nathaniel Edwards
• Daniel Tunon
• Trini Le

See CONTRIBUTING.md for contribution guidelines.

Licensing

MIT