https://github.com/ammezie/tweetr-api
API for a Twitter clone built with AdonisJS
https://github.com/ammezie/tweetr-api
Last synced: about 1 month ago
JSON representation
API for a Twitter clone built with AdonisJS
- Host: GitHub
- URL: https://github.com/ammezie/tweetr-api
- Owner: ammezie
- Created: 2018-02-12T16:17:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-06T21:57:14.000Z (about 7 years ago)
- Last Synced: 2025-03-15T01:02:45.050Z (about 2 months ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 45
- Watchers: 1
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tweetr-api
> API for a Twitter clone built with AdonisJS. The repo for the frontend is available at [https://github.com/ammezie/tweetr-app](https://github.com/ammezie/tweetr-app)
## Getting Started
Clone the project repository by running the command below if you use SSH
```
git clone [email protected]:ammezie/tweetr-api.git
```
If you use https, use this instead
```
git clone https://github.com/ammezie/tweetr-api.git
```
## Setup
Run the command below to install dependencies
```
npm install
```
### Environment variables
Duplicate `.env.example` and rename it `.env`
### Migrations
Setup your database and enter the following in `.env`
```
DB_CONNECTION=mysql
DB_HOST=localhost
DB_DATABASE=tweetr
DB_USER=root
DB_PASSWORD=
```
Run the following command to run migration.
```
adonis migration:run
```
Finally, start the application:
```
adonis serve --dev
```
and visit [http://127.0.0.1:3333](http://127.0.0.1:3333) to see the application in action.