generated from tanikair/ci-full-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 #21 from tanikair/tanikasbranch
readme file
- Loading branch information
Showing
1 changed file
with
128 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,114 +1,180 @@ | ||
|  | ||
| # Prevent | ||
| Prevent is a website and potential organisation that helps in the process of preventing radicalisation and extremism through collaboration with loacl agencies through the resources provided in the site. the long term goal for Prevent is to make a real change in radicalisation numbers in the UK by helping individuals that may be at risk. | ||
|
|
||
| Welcome Tanika Irwin, | ||
| The Prevent site was created with the intention to provide provide clear and accurate information about the prevent strategy that has been put in place by the Government and provide credible resources for community engagement.We aim for users to understand the concept of Prevent and how it aims to counter radicalisation and extremism, as well as understanding what at risk individual's behaviour might look like. | ||
|
|
||
| This is the Code Institute student template for Gitpod. We have preinstalled all of the tools you need to get started. It's perfectly ok to use this template as the basis for your project submissions. | ||
|
|
||
| You can safely delete this README.md file or change it for your own project. Please do read it at least once, though! It contains some important information about Gitpod and the extensions we use. Some of this information has been updated since the video content was created. The last update to this file was: **May 28, 2024** | ||
| ![large.webp] | ||
|
|
||
| ## Gitpod Reminders | ||
| ## Features | ||
|
|
||
| To run a frontend (HTML, CSS, Javascript only) application in Gitpod, in the terminal, type: | ||
| In this section, you should go over the different parts of your project, and describe each in a sentence or so. You will need to explain what value each of the features provides for the user, focusing on who this website is for, what it is that they want to achieve and how your project is the best way to help them achieve these things. | ||
|
|
||
| `python3 -m http.server` | ||
| ### Existing Features | ||
|
|
||
| A blue button should appear to click: _Make Public_, | ||
| - __Navigation Bar__ | ||
|
|
||
| Another blue button should appear to click: _Open Browser_. | ||
| - Featured on all five of the pages, the full responsive navigation bar includes links to the Home page, Programmes page, Get Involved page, My Story page and Gallery page and is identical in each page to allow for easy navigation. | ||
| - This section will allow the user to easily navigate from page to page across all devices without having to revert back to the previous page via the ‘back’ button. | ||
|
|
||
| To run a backend Python file, type `python3 app.py` if your Python file is named `app.py`, of course. | ||
| ![]() | ||
|
|
||
| A blue button should appear to click: _Make Public_, | ||
| - __Signup Modal__ | ||
| - Featured on five of the pages within the NavBar to allow easy access and quick sign up without being relocated to a different page. | ||
| - This feature pops up with an easy to fill out signup form. | ||
|
|
||
| Another blue button should appear to click: _Open Browser_. | ||
| ![]() | ||
|
|
||
| By Default, Gitpod gives you superuser security privileges. Therefore, you do not need to use the `sudo` (superuser do) command in the bash terminal in any of the lessons. | ||
| - __Home Landing Page__ | ||
|
|
||
| To log into the Heroku toolbelt CLI: | ||
| - The landing includes a photograph with text overlay to allow the user to use a button that will reveal contact information if they need immediate help. | ||
| - This section introduces the user to prvent with a background image to set the mood for the site. | ||
|
|
||
| 1. Log in to your Heroku account and go to *Account Settings* in the menu under your avatar. | ||
| 2. Scroll down to the *API Key* and click *Reveal* | ||
| 3. Copy the key | ||
| 4. In Gitpod, from the terminal, run `heroku_config` | ||
| 5. Paste in your API key when asked | ||
| ![]() | ||
|
|
||
| You can now use the `heroku` CLI program - try running `heroku apps` to confirm it works. This API key is unique and private to you, so do not share it. If you accidentally make it public, you can create a new one with _Regenerate API Key_. | ||
| - __Home Page Quotes Section__ | ||
|
|
||
| ------ | ||
| - The Quotes section will allow the user to hear real life quotes from people who have experienced the dangers of radicalisation to give the user something to empathise with. | ||
| - Images and names of the peoples quoted were added for visual interest and user connection to the stories. | ||
|
|
||
| ## Release History | ||
| ![]() | ||
|
|
||
| We continually tweak and adjust this template to help give you the best experience. Here is the version history: | ||
| - __Home Page Stories section__ | ||
|
|
||
| **May 28 2024:** Fix Mongo and Links installs | ||
| - This section will allow the user even more insight into what an indivual whos at risk behvaiour might look like as well as insight into ways Prevent has helped them. | ||
| - This section also provides a link to the My Story page for more case studies. | ||
|
|
||
| **April 26 2024:** Update node version to 16 | ||
| ![]() | ||
|
|
||
| **September 20 2023:** Update Python version to 3.9.17. | ||
| - __The Footer__ | ||
|
|
||
| **September 1 2021:** Remove `PGHOSTADDR` environment variable. | ||
| - The footer section includes links to the relevant social media sites for Prevent. The links will open to a new tab to allow easy navigation for the user. | ||
| - The footer is also provides another option for signup with form and submit button. | ||
|
|
||
| **July 19 2021:** Remove `font_fix` script now that the terminal font issue is fixed. | ||
| ![]() | ||
|
|
||
| **July 2 2021:** Remove extensions that are not available in Open VSX. | ||
| - __Gallery__ | ||
|
|
||
| **June 30 2021:** Combined the P4 and P5 templates into one file, added the uptime script. See the FAQ at the end of this file. | ||
| - The gallery will provide the user with supporting images to see the ideas and tone behind Prevent concepts. | ||
|
|
||
| **June 10 2021:** Added: `font_fix` script and alias to fix the Terminal font issue | ||
| ![]() | ||
|
|
||
| **May 10 2021:** Added `heroku_config` script to allow Heroku API key to be stored as an environment variable. | ||
| - __Programmes Page Image__ | ||
|
|
||
| **April 7 2021:** Upgraded the template for VS Code instead of Theia. | ||
| - This page has all the information and links the user needs to know about the Government's Prevent Programmes. An image is added to the bottom of the page to encourage the initative to prevent radicalisation and for visual interest that breaks up the text on this page. | ||
|
|
||
| **October 21 2020:** Versions of the HTMLHint, Prettier, Bootstrap4 CDN and Auto Close extensions updated. The Python extension needs to stay the same version for now. | ||
| ![]() | ||
|
|
||
| **October 08 2020:** Additional large Gitpod files (`core.mongo*` and `core.python*`) are now hidden in the Explorer, and have been added to the `.gitignore` by default. | ||
| - __Navigation to downloadable document__ | ||
| - When clicking on the Counter Narrative tab in the NavBar it takes the user to a seperate page with a downloadable Government document on the ways to prevent radicalisation and how to identify individuals at risk. | ||
| - This is useful to the user as it provides more information that they are able to download and look back at later on. | ||
|
|
||
| **September 22 2020:** Gitpod occasionally creates large `core.Microsoft` files. These are now hidden in the Explorer. A `.gitignore` file has been created to make sure these files will not be committed, along with other common files. | ||
| ![]() | ||
|
|
||
| **April 16 2020:** The template now automatically installs MySQL instead of relying on the Gitpod MySQL image. The message about a Python linter not being installed has been dealt with, and the set-up files are now hidden in the Gitpod file explorer. | ||
| - __Get Involved Landing Page__ | ||
| - This page includes background image for visual interest and a link to a site that provides resources on how to get involved with the Prevent initiative. This is useful to the users who want to get involved within their local communities that may have Prevent initiatives in place. | ||
|
|
||
| ![]() | ||
|
|
||
| **April 13 2020:** Added the _Prettier_ code beautifier extension instead of the code formatter built-in to Gitpod. | ||
| - __My Story Landing Page__ | ||
| - This section of the My Story page includes a background image to set the tone and a Youtube video on the page for users to hear a case study on radicalisation. | ||
| - The video provides the user another option if they dont want to read more the topic and would prefer to watch. | ||
|
|
||
| **February 2020:** The initialisation files now _do not_ auto-delete. They will remain in your project. You can safely ignore them. They just make sure that your workspace is configured correctly each time you open it. It will also prevent the Gitpod configuration popup from appearing. | ||
| ![]() | ||
|
|
||
| **December 2019:** Added Eventyret's Bootstrap 4 extension. Type `!bscdn` in a HTML file to add the Bootstrap boilerplate. Check out the <a href="https://github.com/Eventyret/vscode-bcdn" target="_blank">README.md file at the official repo</a> for more options. | ||
| - __Case Studies Section__ | ||
| - This section provides a detailed text format to describe through case studies how loacl authorities and Prevent Agencies help prevet radicalisation in real life cases. | ||
| - This gives the user a better understanding and gives the Prevent concept some credibility to show it is actually making real change. | ||
|
|
||
| ------ | ||
| ![]() | ||
|
|
||
| ## FAQ about the uptime script | ||
| - __Immediate Assistance Section__ | ||
| - This section is similar to the immediate assistance toggle on the Home page which provides the user contact details and links if they feel like they need to amke an immediate referral due to someone being potentionally at risk. | ||
|
|
||
| **Why have you added this script?** | ||
| ![]() | ||
|
|
||
| It will help us to calculate how many running workspaces there are at any one time, which greatly helps us with cost and capacity planning. It will help us decide on the future direction of our cloud-based IDE strategy. | ||
| ### Features Left to Implement | ||
|
|
||
| **How will this affect me?** | ||
| - Case Studies Carousel | ||
| - There could be an option for visual interest to scroll through Case Study image which when clicked can take the user to a seperate page with more information on the case study they clicked on. | ||
|
|
||
| For everyday usage of Gitpod, it doesn’t have any effect at all. The script only captures the following data: | ||
| ## Testing | ||
|
|
||
| - An ID that is randomly generated each time the workspace is started. | ||
| - The current date and time | ||
| - The workspace status of “started” or “running”, which is sent every 5 minutes. | ||
|
|
||
| It is not possible for us or anyone else to trace the random ID back to an individual, and no personal data is being captured. It will not slow down the workspace or affect your work. | ||
| On both mobile and tablet the NavBar confines down into a dropdown toggle. Images and Videos are also sized to fit in relation to the screen sizes on different devices allowing the visuals to be clear on all screens. | ||
|
|
||
| **So….?** | ||
| Most of the bugs/errors within our code related to Image files not being corrected and missing closing tabs which were easy and quick to solve allowing us to have a fully validated HTML and CSS files. | ||
|
|
||
| We want to tell you this so that we are being completely transparent about the data we collect and what we do with it. | ||
| An interesting bug we have found is that on the My Story page the Heading is cut off for some desktops and others is fully visable. | ||
|
|
||
| **Can I opt out?** | ||
| ### Validator Testing | ||
|
|
||
| Yes, you can. Since no personally identifiable information is being captured, we'd appreciate it if you let the script run; however if you are unhappy with the idea, simply run the following commands from the terminal window after creating the workspace, and this will remove the uptime script: | ||
| - HTML | ||
| - No errors were returned when passing through the official [W3C validator](https://validator.w3.org/nu/?doc=https%3A%2F%2Fcode-institute-org.github.io%2Flove-running-2.0%2Findex.html) | ||
| - CSS | ||
| - No errors were found when passing through the official [(Jigsaw) validator](https://jigsaw.w3.org/css-validator/validator?uri=https%3A%2F%2Fvalidator.w3.org%2Fnu%2F%3Fdoc%3Dhttps%253A%252F%252Fcode-institute-org.github.io%252Flove-running-2.0%252Findex.html&profile=css3svg&usermedium=all&warning=1&vextwarning=&lang=en#css) | ||
|
|
||
| ``` | ||
| pkill uptime.sh | ||
| rm .vscode/uptime.sh | ||
| ``` | ||
|
|
||
| **Anything more?** | ||
| ## Deployment | ||
|
|
||
| Yes! We'd strongly encourage you to look at the source code of the `uptime.sh` file so that you know what it's doing. As future software developers, it will be great practice to see how these shell scripts work. | ||
| This section should describe the process you went through to deploy the project to a hosting platform (e.g. GitHub) | ||
|
|
||
| --- | ||
| - The site was deployed to GitHub pages. The steps to deploy are as follows: | ||
| - In the GitHub repository, navigate to the Settings tab | ||
| - From the source section drop-down menu, select the Master Branch | ||
| - Once the master branch has been selected, the page will be automatically refreshed with a detailed ribbon display to indicate the successful deployment. | ||
|
|
||
| The live link can be found here - https://tanikair.github.io/PreventProject/ | ||
|
|
||
|
|
||
| ## Credits | ||
|
|
||
| In this section you need to reference where you got your content, media and extra help from. It is common practice to use code from other repositories and tutorials, however, it is important to be very specific about these sources to avoid plagiarism. | ||
|
|
||
| You can break the credits section up into Content and Media, depending on what you have included in your project. | ||
|
|
||
| ### Content | ||
|
|
||
|
|
||
| - Other Resource Links | ||
|
|
||
| https://www.officeforstudents.org.uk/advice-and-guidance/student-wellbeing-and-protection/counter-terrorism-the-prevent-duty/prevent-case-studies/ | ||
|
|
||
| https://www.preventwatch.org/cases/ | ||
|
|
||
| https://www.educateagainsthate.com/are-there-real-world-examples-of-cases-where-successful-interventions-have-stopped-a-young-person-being-radicalised/ | ||
|
|
||
| The Education site for webinars etc | ||
| https://www.et-foundation.co.uk/professional-development/safeguarding-prevent/forums-webinars/ | ||
|
|
||
|
|
||
| - Videos | ||
|
|
||
| What is PREVENT? Introduction to the Prevention of Radicalisation | ||
| https://www.youtube.com/watch?v=rtFvL8BmpT8&t=12s&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| Safer Devon: Online Radicalisation | ||
| https://www.youtube.com/watch?v=NHmOnCRAGvw&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| Prevent Training | ||
| https://www.youtube.com/watch?v=ptoraXKGfpA&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| What is Prevent? | ||
| https://www.youtube.com/watch?v=1os0hDJIjy0&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| Preventing Radicalisation and Extremism | ||
| https://www.youtube.com/watch?v=nN3h1YMDTXE&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| Radicalisation and extremism - educational video | ||
| https://www.youtube.com/watch?v=4Ph536eGzbA&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| Prevent - Radicalisation | ||
| https://www.youtube.com/watch?v=GF01JWdEk5M&pp=ygUccHJldmVudCByYWRpY2FsaXNhdGlvbiB2aWRlbw%3D%3D | ||
|
|
||
| - The icons in the footer were taken from [Font Awesome](https://fontawesome.com/) | ||
|
|
||
| ## Other | ||
|
|
||
| - Link to Wireframes using Balsamiq | ||
| https://balsamiq.cloud/srhpwk3/p5ayom5 | ||
|
|
||
| Happy coding! |