Skip to content

Stabilized README for migration of backend to NodeJS #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChubaOraka wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Stabilized README for migration of backend to NodeJS #29

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a114012
Removed extraneous files
ChubaOraka Aug 5, 2022
1334174
Removed extraneous files from server and db container image builds
ChubaOraka Aug 5, 2022
5a9c958
Created a container image for the frontend and ensured that it exclud…
ChubaOraka Aug 5, 2022
d9b7ed0
Created a docker-compose file for fullstack development
ChubaOraka Aug 5, 2022
253821f
Enabled hot reloading
ChubaOraka Aug 5, 2022
b67d041
Connected frontend to backend with proxy to get rid of CORS errors
ChubaOraka Aug 5, 2022
2e132ad
Bugfix: Enabled the server to connect to the database despite name co…
ChubaOraka Aug 5, 2022
0bb73c2
Documented instructions for fullstack project setup
ChubaOraka Aug 5, 2022
cb9d8e3
Added instructions on cloning repository
ChubaOraka Aug 21, 2022
940bc4d
Added instruction on switching to last commit with Flask backend
ChubaOraka Aug 21, 2022
a707d1a
Changed commit hash to more recent commit so user can have access to …
ChubaOraka Aug 21, 2022
fdface1
Merge branch 'main' into stabilize-README-for-migration-of-backend-to…
ChubaOraka Aug 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ This is project is structured so that the developer can choose to set it up with
<br />

# **PROJECT SETUP**
## **Cloning Project**
Clone this repo and change directory into the project root folder by running the following commands:

```bash
git clone https://github.com/KanaryStack/aliascheck.git
```
>NOTE:
>If you have setup an SSH connection to this repo, you can run this command instead:
>```bash
>git clone git@github.com:KanaryStack/aliascheck.git
>```

and go to the project root folder like so:
```bash
cd aliascheck
```
then switch to last stable branch with Flask backend:
```bash
git checkout 940bc4d36f8a34e65373e080024cf98d97b4cf52

@simplytunde simplytunde Aug 21, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will recommend we only merge(probably will need further update) after a Node PR is merged to master.

Suggested change
git checkout 940bc4d36f8a34e65373e080024cf98d97b4cf52
git checkout main

This will allow us to give specific contribution/setup instruction to the contributor/user.

@simplytunde simplytunde Aug 23, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once the PR is merged, we can update this README apprpriately #26

```

## **Starting Up the Project**
## **With Docker Compose**
To start the project using Docker, even from scratch, run the following command:

Expand Down