Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmedfouzan/pitcher
An image sharing Web application built on NodeJS
https://github.com/ahmedfouzan/pitcher
bcrypt bootstrap bootstrap3 image-sharing instagram javascript jquery neo4j neo4j-database neo4j-driver nodejs passportjs restful social-network video-streaming
Last synced: 4 days ago
JSON representation
An image sharing Web application built on NodeJS
- Host: GitHub
- URL: https://github.com/ahmedfouzan/pitcher
- Owner: ahmedfouzan
- License: mit
- Created: 2017-02-03T18:54:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-04T20:40:51.000Z (almost 8 years ago)
- Last Synced: 2024-11-10T09:35:31.542Z (2 months ago)
- Topics: bcrypt, bootstrap, bootstrap3, image-sharing, instagram, javascript, jquery, neo4j, neo4j-database, neo4j-driver, nodejs, passportjs, restful, social-network, video-streaming
- Language: TypeScript
- Homepage:
- Size: 7.45 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pitcher
An image sharing web application, with additional features like video sharing, live video streaming, chat.
### Version
1.0.0
## Prerequisites
* [NodeJS](https://nodejs.org/)
* [Neo4j](https://neo4j.com/)
## Installation
Clone this repository
```bash
git clone https://github.com/ahmedfouzan/pitcher.git
```
Change into the directory
```bash
cd pitcher
```
Install the dependencies
```bash
npm install
```
### Running
Run the app
```bash
npm start
```
## End Points
Using the following endpoints you can
* Register a user
```
POST /users/register
```
* Login
```
POST /users/authenticate // Gives a token
```
* Go to a protected route
```
GET /users/profile // Requires token to authorize
```
## Built With
* Serverside - [NodeJS](https://nodejs.org/), [ExpressJS](http://expressjs.com/)
* Database - [Neo4j](https://neo4j.com/)
* Frontend - [Bootstrap](https://getbootstrap.com/), [JQuery](https://jquery.com/), [AngularJS](http://angularjs.org/)
## Authors
* [**Ahmed Fouzan**](https://github.com/ahmedfouzan)
* [**Mohammed Imran**](https://github.com/imran-14)
* [**Heerak Agrawal**](https://github.com/heerak23)
## License
[MIT](http://opensource.org/licenses/MIT)