Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
git25126 committed Dec 28, 2024
1 parent 8af43b2 commit a5b6016
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 13 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@
This project shows you how to build a basic web application using popular web technologies
like NPM, Webpack, React and Python.


## Let's Build It Together!

You can find a walkthrough of how to build this application from scratch on
[my blog](https://codeburst.io/creating-a-full-stack-web-application-with-python-npm-webpack-and-react-8925800503d9).

## Installing and Running
After cloning this repository to your computer, you need to perform the following steps to be able to run it:
1) Ensure you have npm, python and pip installed on your machine.
Expand All @@ -19,25 +13,22 @@ This will download and install the dependencies listed in package.json.
4) Install flask (pip install flask).
5) Start the server. Go to the server directory and do "python server.py".


## Jumping to Different Completion Points

You can use the git tags to jump to different completion points in the code.

### Basic Setup
If you go to the [BASIC_E2E_TEMPLATE](https://github.com/angineering/FullStackTemplate/tree/BASIC_E2E_TEMPLATE)
If you go to the [BASIC_E2E_TEMPLATE](https://github.com/robintech514/FullStackTemplate/tree/BASIC_E2E_TEMPLATE)
tag, you will find the application as it will be when you've followed the first blog post to the end.
You will have a basic web application with a Python backend and a React front-end, but they won't be passing
any data between each other yet.

### A Simple Website
If you go to the [SIMPLE_WEBSITE](https://github.com/angineering/FullStackTemplate/tree/SIMPLE_WEBSITE) tag,
If you go to the [SIMPLE_WEBSITE](https://github.com/robintech514/FullStackTemplate/tree/SIMPLE_WEBSITE) tag,
you get a simple website with a button requesting info from python and displaying the result.
It has a nice design, as a background image and CSS support has been added.

When you click the button, 'Hello' will be displayed in a random European language.

This is what it looks like:
![Simple Website](simple_website.png?raw=true "A Simmple Website")


2 changes: 1 addition & 1 deletion fullstack_template/static/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/angineering/FullStackTemplate.git"
"url": "https://github.com/robintech514/FullStackTemplate.git"
},
"author": "Angela Branaes",
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
author='Angela Branaes',
author_email='[email protected]',
license='MIT',
url='https://github.com/angineering/FullStackTemplate',
url='https://github.com/robintech514/FullStackTemplate',
keywords = [ 'fullstack', 'template', 'python', 'react','npm', 'webpack'],
classifiers = [
'Topic :: Software Development',
Expand Down

0 comments on commit a5b6016

Please sign in to comment.