-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0e36777
commit 0e080db
Showing
12 changed files
with
27 additions
and
37 deletions.
There are no files selected for viewing
File renamed without changes.
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
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,19 +1,13 @@ | ||
# Pixelgram | ||
|
||
**Pixelgram** is an image-sharing application where users can create, | ||
**Pixelgram** is an image-sharing application where users can create, | ||
browse and like images. | ||
|
||
## Screenshots | ||
|
||
Feed | Profile | ||
--- | --- | ||
[![Screenshot of feed screen](/docs/img/01_feed.png)](/docs/img/01_feed.png) | [![Screenshot of profile screen](/docs/img/02_profile.png)](/docs/img/02_profile.png) | ||
|
||
## Architecture | ||
|
||
Service | Language | Description | ||
--- | --- | --- | ||
[backend](/src/backend) | Python | Backend of the app, responsible for users, posts and authentication. | ||
[backend](/src/backend) | JavaScript | Backend of the app, responsible for users, posts and authentication. | ||
[database](/src/database) | SQL | PostgreSQL database with tables, relationships and functions. | ||
[frontend](/src/frontend) | TypeScript | Angular frontend of the app. | ||
|
||
|
@@ -24,48 +18,48 @@ Service | Language | Description | |
Clone the repository to your filesystem | ||
|
||
```sh | ||
$ git clone [email protected]:robbdimitrov/pixelgram.git | ||
$ cd pixelgram | ||
git clone [email protected]:robbdimitrov/pixelgram.git | ||
cd pixelgram | ||
``` | ||
|
||
### Build the images | ||
|
||
Build all the images | ||
|
||
```sh | ||
$ make | ||
make | ||
``` | ||
|
||
Or build specific images | ||
|
||
```sh | ||
$ make backend | ||
$ make database | ||
$ make frontend | ||
make backend | ||
make database | ||
make frontend | ||
``` | ||
|
||
### Create namespace | ||
|
||
Create namespace for the k8s resources | ||
|
||
```sh | ||
$ kubectl create namespace pixelgram | ||
kubectl create namespace pixelgram | ||
``` | ||
|
||
### Create deployments | ||
|
||
Create deployments and volumes | ||
|
||
```sh | ||
$ kubectl apply -f ./k8s -n pixelgram | ||
kubectl apply -f ./k8s -n pixelgram | ||
``` | ||
|
||
## Access the frontend | ||
|
||
Enable port forwarding | ||
|
||
```sh | ||
$ kubectl port-forward service/frontend 8080 -n pixelgram | ||
kubectl port-forward service/frontend 8080 -n pixelgram | ||
``` | ||
|
||
Open the frontend [here](http://localhost:8080/). | ||
|
@@ -75,18 +69,18 @@ Open the frontend [here](http://localhost:8080/). | |
Delete all resources | ||
|
||
```sh | ||
$ kubectl delete -f ./k8s -n pixelgram | ||
kubectl delete -f ./k8s -n pixelgram | ||
``` | ||
|
||
Delete the namespace | ||
|
||
```sh | ||
$ kubectl delete namespace pixelgram | ||
kubectl delete namespace pixelgram | ||
``` | ||
|
||
## API | ||
|
||
The API documentation is available [here](/docs/API.md). | ||
The API documentation is available [here](/API.md). | ||
|
||
## License | ||
|
||
|
Binary file not shown.
Binary file not shown.
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
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
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
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
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
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
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