generated from hcp-uw/react-express-starter-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #58 from hcp-uw/zth12301-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
2 additions
and
62 deletions.
There are no files selected for viewing
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,65 +1,5 @@ | ||
# Green Notes (change more stuff later) | ||
|
||
A simple template repository with a React frontend and Express backend for quickly starting new full-stack projects. | ||
|
||
## Prerequisites ‼️ | ||
|
||
To use this template, you need to have the following installed on your machine: | ||
|
||
- Node.js | ||
- npm | ||
|
||
## Getting Started ▶️ | ||
|
||
These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes. | ||
|
||
### Installation 💭 | ||
|
||
1. Clone the repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/hcp-uw/project-starter-template.git | ||
``` | ||
|
||
2. Change into the project's directory: | ||
|
||
```bash | ||
cd project-starter-template | ||
``` | ||
|
||
|
||
3. Install the required dependencies for both the frontend and backend: | ||
|
||
```bash | ||
cd starter-frontend | ||
npm i | ||
cd ../starter-backend | ||
npm i | ||
``` | ||
|
||
## Development 💻 | ||
|
||
To start the development environment, follow these steps: | ||
|
||
1. Start your server (from the root of the project): | ||
|
||
```bash | ||
cd starter-backend | ||
npm start | ||
``` | ||
|
||
2. In a new terminal window (starting from the root of your project): | ||
```bash | ||
cd starter-frontend | ||
npm start | ||
``` | ||
|
||
|
||
### Authors 📝 | ||
|
||
[Elijah Melton](https://github.com/elimelt) | ||
|
||
### Contributing 🤝 | ||
|
||
If you have any feedback feel free to submit an issue/pull request! Contributions are more than welcome. | ||
Take notes for cs students. Big cool. | ||
|
||
Link to site: https://hcp-uw.github.io/green-notes |