forked from lighthouse-labs/tweeter
-
Notifications
You must be signed in to change notification settings - Fork 0
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 lighthouse-labs#13 from hora/update-readme
Updates readme
- Loading branch information
Showing
1 changed file
with
7 additions
and
29 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,39 +1,17 @@ | ||
# Tweeter Project | ||
|
||
A simple single-page AJAX-based Twitter clone that uses jQuery, HTML5 and plain ol' CSS3 to help web bootcamp students get comfortable with their front-end chops with those technologies. | ||
Tweeter is a simple, single-page Twitter clone. | ||
|
||
## Technical Approach & Objectives | ||
|
||
This project is starter (incomplete) code for students to fork and clone, located here. | ||
|
||
The server is built with Node and Express and allows users to request and submit tweets via a JSON end-point. The server/express code should not require any change from the student. | ||
|
||
Students must work with and implement the HTML, CSS and client-side JS to bring this project to life. | ||
|
||
## Final Product | ||
|
||
The end result should look and function like this: | ||
|
||
 | ||
This repository is the starter code for the project: Students will fork and clone this repository, then build upon it to practice their HTML, CSS, JS, jQuery and AJAX front-end skills, and their Node, Express and MongoDB back-end skills. | ||
|
||
## Getting Started | ||
|
||
1. Fork and clone your fork of this repository. | ||
2. Install dependencies: `npm install` or `npm i` for short. | ||
3. Start the web server from the command line: `npm run local` | ||
4. Open the app on <http://localhost:8080/> and make sure that it's loading. | ||
1. Fork this repository, then clone your fork of this repository. | ||
2. Install dependencies using the `npm install` command. | ||
3. Start the web server using the `npm run local` command. The app will be served at <http://localhost:8080/>. | ||
4. Go to <http://localhost:8080/> in your browser. | ||
|
||
## Dependencies & Troubleshooting | ||
|
||
Dependencies: | ||
## Dependencies | ||
|
||
- Express | ||
- Node 5.10.x or above | ||
|
||
**This project assumes that:** | ||
|
||
- It is running in our Vagrant machine (and therefore...) | ||
- It is Running with Node 5.10.x or above | ||
|
||
|
||
|