Skip to content
This repository has been archived by the owner on Feb 14, 2024. It is now read-only.

Commit

Permalink
Lost ReadMe in accidental commit, here is the correct
Browse files Browse the repository at this point in the history
  • Loading branch information
@juniajanvier
juniajanvier authored Dec 21, 2022
1 parent a2920b0 commit 2387d4e
Showing 1 changed file with 120 additions and 53 deletions.
173 changes: 120 additions & 53 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,3 @@
### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a name="readme-top"></a>
<br />

Expand All @@ -56,10 +15,6 @@ To learn React, check out the [React documentation](https://reactjs.org/).
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
Expand Down Expand Up @@ -88,16 +43,23 @@ Look at our Final Presentation to see our progress overview from Fall 2022: [Fin

### Built With

Our Technical Stack
**Our Technical Stack**
Frontend

- [React](https://reactjs.org/)
- [Bootstrap](https://getbootstrap.com/)
- [NpmJS](https://www.npmjs.com/)
- [Typescript](https://www.typescriptlang.org)
- [MUI](https://mui.com/)
- [Firebase](https://firebase.google.com/)

CMS

- [Strapi](https://strapi.io/)

Deployment

- [Firebase](https://firebase.google.com/)

<p align="left">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->
Expand All @@ -106,9 +68,11 @@ Our Technical Stack

Please review the following sections to understand how to run this project on your local device. To run properly please make sure you have the most updated version of **ReactJS, NodeJS, NPM, and Firebase.**

### Frontend
For **React** you can learn more in the [Create React App Documentation](https://create-react-app.dev/docs/getting-started/)

## Prerequisites
## Frontend

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Expand All @@ -117,9 +81,9 @@ This is an example of how to list things you need to use the software and how to
npm install npm@latest -g
```

## Installation (TO RUN THE FRONTEND)
### Installation (TO RUN THE FRONTEND)

_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
_How to run the current project on local device:_

1. Clone the repo
```sh
Expand All @@ -133,16 +97,116 @@ _Below is an example of how you can instruct your audience on installing and set

```sh
cd frontend
npm start
```

_Runs the frontend from local host Open [http://localhost:3000](http://localhost:3000) to view it in the browser. Will update when edits are made._

**Other useful npm commands**

```sh
npm test
```

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

```sh
npm run build
```

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

```sh
npm run eject
```

_Note: this is a one-way operation. Once you `eject`, you can’t go back!_

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

<p align="left">(<a href="#readme-top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->

## Usage
## Strapi

**Brief:** Recommend to build and test content locally and deploy to google cloud after everything is set.

**To host locally:**

```sh
cd new-strapi
npm install
```

Create .env file and paste following:

_HOST=0.0.0.0_
_PORT=1337_
_APP_KEYS=hq5nXeyU/6AUVnkkdHmmqA==,c1W7ivCD+NMYGnpjiLOoMQ==,l2cE5Bfqejdgs//K8Aa7Ag==,ZlqpAcH2lPYYbP8QqTb2bg==_
_API_TOKEN_SALT=WSeDbXcQ7JgJ1tMKGhsIXw==_
_ADMIN_JWT_SECRET=w3fdKjGIQ4m0bJOYQxRBbA==_
_JWT_SECRET=EC1lm5cICpaxnYCl2990Ig==_

```sh
npm run develop
```

**To login in:** Create your own account and start
**To deploy:** [Google App Engine Deployment - Strapi Developer Docs](https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/google-app-engine.html)

# Usage

**Strapi Usage**

- Build a collection type for each page and create component for sections if needed
- Add page content as entry on corresponding field.
- Be sure to publish the content after it is finished.
- Go Setting-> USERS & PERMISSIONS PLUGIN -> roles -> public to check the corresponding field in order to get the data.

Here is what the final website should look like: [Figma Wireframe](https://www.figma.com/proto/c5bBNfzCRal0xi7EWuEK4s/Partner-to-Decide_Final-Handoff-File?node-id=5453%3A18754)

## Deployment

**For deploying frontend to firebase:**
To host locally:

```sh
cd frontend
npm install && npm run start
```

$cd frontend
$npm install && npm run start

**To redeploy site and push new changes:**

```sh
npm run build
firebase deploy --only hosting
```

**To redesignate github repo for CI/CD:**

```sh
firebase login
cd frontend
firebase init
```

_follow prompt for connecting to GitHub_

<p align="left">(<a href="#readme-top">back to top</a>)</p>

<!-- ROADMAP -->
Expand All @@ -157,9 +221,11 @@ Here is what the final website should look like: [Figma Wireframe](https://www.f
- [x] Create Notes App
- [ ] Fix Quiz array bug (array doesn't reset when page refreshed, repeats values)
- [ ] Fix Hosting bug, can only use home page url, if typed in with directory to other pages in browser, site returns a 404 error (however once on main page, site pages are accessible)
- [ ] Fix Issue with Strapi parsing issue
- [ ] Fix issue with maintaining Strapi data
- [ ] Please see Jira for additonal tasks to be completed, please check-in with client to verify these backlog items: [Jira Page](https://sparkjedi.atlassian.net/jira/software/projects/DS519BU/boards/1/backlog?selectedIssue=DS519BU-28)

See the [open issues](https://github.com/BU-Spark/se-shared-decision-making/issues) to add recommended features, and to log future issues (Quiz and 404 error included).
See the more detailed [open issues](https://github.com/BU-Spark/se-shared-decision-making/issues) to add recommended features, and to log future issues (Quiz and 404 error included).

<p align="left">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -198,6 +264,7 @@ Here are some helpful resources to kick off the project!
- [React Icons](https://react-icons.github.io/react-icons/search)
- [Jira Board (Includes any bugs remaining)](https://sparkjedi.atlassian.net/jira/software/projects/DS519BU/boards/1/backlog?selectedIssue=DS519BU-28)
- [Intro to Typescript](https://www.w3schools.com/typescript/index.php)
- [How to Create a Survey Application Using Strapi and React.JS](https://strapi.io/blog/creating-a-survey-application-using-strapi-and-react-js)

<p align="left">(<a href="#readme-top">back to top</a>)</p>

Expand Down

0 comments on commit 2387d4e

Please sign in to comment.