Joia

  Joia © 2021 All Rights Reserved. All material must be cited or credited, when using material.

Table of Contents

• Repository Description
• User Story
• Usage Information
• Authors
• Contribution Guidelines
• References
• Acknowledgements
• Repositiory End-Goal Criteria

Repository Description

Back to Table of Contents

You live in a busy world; and thriving businesses are busier. You don't have time . Don't worry, WE got this: We're Joia, "HELLO, WORLD!" Joia, pronounced as "Joy-ah," means gem or jewel. Joia is your jewel eCommerce website for local art, where you can find your gem for your Jewel or Jim!

User Story

As A Developer

Back to Table of Contents

1. TBD...

Usage Information

Back to Table of Contents

This project can be used for projects, non-profit organizations, academic clubs; and much more! Not for commercial use, unless granted by the authors.

Authors

      

Select images above to visit the author's GitHub Profile. The names following images left to right are: Connor Favero, Rattanak Leng, Andrew Olson, and Frederick Thomas, Super Coding Ninja™

Contribution Guidelines

Back to Table of Contents

I hope you enjoy this repository, and the application's link, given above and below (I love developing new projects). Please read and follow license instructions. Thank you for viewing!

Installation Instructions

Back to Table of Contents

1. Ensure that your application includes the require dependencies, by typing the command in your integrated terminal
   • npm install inquirer
   • sass source/stylesheets/index.scss build/stylesheets/index.css
   • npm install -g sass
   • brew install sass/sass/sass
   • TBD on "Require"...
   • Install R Markdown for Visual Studio Code IDE chosen
     1. Close Visual Studio.
     2. (One time only) Install pandoc from pandoc.org.
        • brew install pandoc
     3. Restart Visual Studio, which should pick up the pandoc installation.
     4. Install the knitr and rmarkdown packages, which you can do from the interactive window:
        • install.packages("knitr")
        • install.packages("rmarkdown")
2. Create a .gitignore file and include node_modules/ and .DS_Store/ so that your node_modules directory isn't tracked or uploaded to GitHub.
3. Run “node [fileName].js”

Development Instructions

from under the Joia directory:

1. Create a file named ".env" in the project root directory (probably "Joia") adding the single line "JWT_SECRET=" where is, well, ANY STRING, I have "JWT_SECRET=123456789". It doesn't really matter what the string is set to so long as it is set.
2. Ensure that you have all the node modules installed by typing
   • npm i
3. Launch your editor
   • code .
4. Launch the projects to run locally in development mode:
   • npm run start BONUS: under the server directory, run tests. Particularly if you've made any server changes:
   • cd server
   • npm test

Things will rebuild and relaunch automatically as you edit the code to ensure the running code reflects the code changes as you make them.

The above development setup will be suitable for most or all development. You may stop reading now if you just want to do some light development. The above is the convienent and recommended way or doing development. That said, there are some minor variations on this that may be interesting to know about for the bored or adventurous. One variation on the above is included for use in "production" (on Heroku, as we're using it). The following steps mirror how Heroku deployment works:

from under the Joia directory:

1. Ensure that you have all the node modules installed by typing
   • npm i
2. Build the project
   • npm run build
3. Launch the node server
   • npm run start
4. Launch a browser and navigate to http://localhost:3001/

The differences you'll observe will be that there will be a /build/ directory under Joia after step 2 and also step 3 will launch node to run under this /build/ directory. The server will be running at http://localhost:3001/ and you'll need to launch a browser and go there since one won't launch automatically in the third step. Hence the fourth.

Another variation that reflects how it is run on Heroku is to specify the MONGODB_URI, the connection string used by mongoose to figure out how to connect to the database. If it is not deliberately set to be otherwise, the string used will be "mongodb://localhost/populate" which specifies to use your local install of mongo in a database named "populate". And this is perfectly fine for development purposes. But Heroku will not have a mongo instance. We set it to use an ATLAS instance when running there. How so? This is set in an environment variable on Heroku, for which Heroku has a "dashboard" that allows for configuration. We may mimic this process locally if we choose. We could set environment variables on our machine but this can get messy. So instead, we use a node package, dotEnv, that allows for effective environment settings to be specified by creating a file named ".env" and settings values in there. I have one such .env sitting in my Joia directory with one line

MONGODB_URI=mongod+svr://myatlasusername:myatlaspassword@cluster0.va5bm.mongodb.net/myFirstDatabase

A final variation that reflects the Heroku environment is replacing the command at step 1 with: npm install --only=prod

Heroku minimizes the number of node_modules installed by avoiding downloading the devDependencies

Doing this or even knowing about it is unnecessary for local development and is only probably worth knowing in case connectivity problems come up which you're trying to diagnose.

Overview: What We Accomplished!

Workflow Back to Table of Contents

Created an awesome eCommerce website.

Media

Back to Table of Contents

TBD...

References

Back to Table of Contents

1. NPMjs provides Documentation, Installation, Examples, Methods, Objects, Questions, Answers, Separator, Prompt Types, User Interfaces and Layouts, Reactive Interface, Support, Known issues, News, Contributing, License, and Plugins.

2. Shields IO provides documentations on how to add your shield, for creditbility. Please feel free to view this resource, for your future developments.

3. .saas || .scss || .css The comparisons and usages of Syntactically Awesome Style Sheets, SassScript; and Cascaded Style Sheets.

4. SAAS || CSS

5. "CSS w/Super Powers"

6. Eloquent JavaScript, 3rd edition (2018) This is a book about JavaScript, programming, and digital wonders. Read it online here; or get your own paperback copy. Written by Marijn Haverbeke. Licensed under a Creative Commons attribution-noncommercial license. All code in this book may also be considered licensed under an MIT license.

7. Guide to Handlebars: Templating Engine for Node/JavaScript explains that express is a routing, and middleware is a web framework; which has minimal functionality of its own (express applications are series of middleware function calls).

8. Using Middleware and Express Guide to Handlebars: Templating Engine for Node/JavaScript, by Janith Kasun helps you understand Template Engines, Handlebars; and how to use them!

9. Web Application Architecture describes architecture, Models of Web Componets,Types of Web Application Architecture; and Web App Development Tips!

10. Markdown Syntax provides documentations on how to add your shield, for creditbility. Please feel free to view this resource, for your future developments.

11. eCommerce Styles & Ideas - How to Code an Ecommerce Site (Week 10 of 12) by Mackenzie Child - 10 stunning hover effects with sass by Renan C. Araujo

12. /* Dynamic Flower, by Frederick Thomas, Super Coding Ninja™, and Dynamic Flower, by Frederick Thomas.

13. [“ui-illustration-business-people-concept“](https://www.freepik.com/vectors/background]

14. ["free-vector-human-silhouette-14.htm"](http://clipart-library.com/clip-art/free-vector-human-silhouette-14.htm/]

15. “free-vector-human-silhouette-11”

16. “8Tx85kXTp”

17. Create vectors at https://vectormagic.com/

18. “Using border-radius to make shapes: how to build a flower”, Maks Akymenko.

19. Building the Login Component in React JS

Ackowledgements

Back to Table of Contents

University of Washington, and Trilogy Education (a 2U, Inc. brand), in coorelation to their Seattle Partnership UW Coding Bootcamp.

Repositiory End-Goal Criteria

Back to Table of Contents

Make it a point to tackle new code, weekly (at least, periodaclly); and break it down. Try to understand the concepts, yourself. This only makes you more credible, and a stonger developer: because you've taken the time to study! Remember this also, as a developer, your goal should be designing NEW experiences that makes people's lives simple; because as developers, we solve problems that people didn't even knew they had- even better, in a way that they do not understand: We are the super heroes and heriones of tomorrow; so get coding, and I hope this repository helps you along your development. Stay on task, Get Ahead, Change The World!

License

Joia © 2021 Connor Favero, Rattanak Leng, Andrew Olson, and Frederick Thomas, Super Coding Ninja™.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.