https://github.com/ajibs/mini-twitter
Connect with other people. (Mini Twitter Clone)
https://github.com/ajibs/mini-twitter
mongodb nodejs pug twitter-clone
Last synced: about 1 month ago
JSON representation
Connect with other people. (Mini Twitter Clone)
- Host: GitHub
- URL: https://github.com/ajibs/mini-twitter
- Owner: ajibs
- License: mit
- Created: 2018-02-25T00:14:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-25T22:44:44.000Z (over 8 years ago)
- Last Synced: 2025-11-19T16:02:55.385Z (7 months ago)
- Topics: mongodb, nodejs, pug, twitter-clone
- Language: JavaScript
- Homepage: https://mini-twitterify.herokuapp.com/
- Size: 679 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twitterify
Connect with other people.
Twitterify is a [Chaser](https://chaserhq.com/) Project.
## Feature List
* User can signup and login
* Authenticated User can post a tweet (max of 200 characters)
* Autheticated User can reply to tweets
* On replying someone, they would be notified via email
* User is able to view all tweets and replies
* Authenticated User can like tweets
## Getting Started
Twitterify is hosted on Heroku and can be accessed here:
- [Production](https://mini-twitterify.herokuapp.com/)
You can visit the application by clicking the above link and play around with the features.
## Prerequisites
These are what you need installed on your computer to use the application:
- Web Browser (Chrome, or Mozilla, or Safari, or Opera, or Microsoft Edge )
#### For Developers:
- [Node.js](https://nodejs.org/en/download/)
- [Yarn](https://yarnpkg.com/en/docs/install)
## Setup
#### Local Copy
To create a local copy, run the following in your terminal:
```bash
git clone https://github.com/ajibs/mini-twitter.git
```
Then change into the local directory, run the following in your terminal:
```bash
cd mini-twitter
```
#### Install Node.js and Yarn
If you don't have Node.js installed, please go ahead and grab it [here](https://nodejs.org/). This project uses ES6+ features and requires Node version `8.9.4`
Yarn is a package manager for Node.js and can be installed from [here](https://yarnpkg.com/en/docs/install).
To confirm that you have Node.js installed, run the following in your terminal:
```bash
node -v
```
You should get something like `v8.9.4`.
To confirm that you have Yarn installed, run the following in your terminal:
```bash
yarn -v
```
You should get something like `1.3.2`.
#### Setup Database and .env file
You should also create a `.env` file using `.env.sample` as a prototype. Run the following in your terminal:
```bash
cp .env.sample .env
```
You can setup a database on [mlab](https://mlab.com/) and replace the `DATABASE` placeholder in `.env`
Signup on [Mailtrap](https://mailtrap.io/) and replace the placeholders of `MAIL_USER` and `MAIL_PASS` in `.env` to ensure the email functionality works.
#### Install Node.js Modules
To install all dependencies, run the following in your terminal:
```bash
yarn
```
## Development
To kickstart the application, run the following in your terminal:
```bash
yarn start
```
If you'd like to continue full-stack development on this project, run the following in your terminal:
```bash
yarn dev
```
Open up your web browser and visit the following url to seed the database:
```bash
http://localhost:4400/seed
```
Visit the following to access the home page
```bash
http://localhost:4400/
```
## Built With
- [Git](https://git-scm.com/) - Version Control
- [Node.js](https://nodejs.org/) - JS Runtime Environment
- [Yarn](https://yarnpkg.com) - Package Manager
- [MongoDb](https://www.mongodb.com/download-center#community) - Database
- [Express](https://expressjs.com/en/starter/installing.html) - Web Framework
- [Pug](https://pugjs.org/api/getting-started.html) - Templating Engine
- [Webpack](https://webpack.js.org/) - Build Tool
- [Babel](https://babeljs.io/) - Transpiler
- [ESLint](https://eslint.org/) - Linting Tool
- [mLab](https://mlab.com/) - Database Hosting
- [Heroku](https://heroku.com) - Hosting and Continuous Deployment
- [VS Code](https://code.visualstudio.com/) - Code Editor
- [Chrome](https://www.google.com/chrome/browser/desktop/index.html) - Browser
## Author
* [Bolu Ajibawo](https://github.com/ajibs)