Skip to content

Commit

Permalink
mock repo established
Browse files Browse the repository at this point in the history
  • Loading branch information
@specter25
specter25 committed Oct 2, 2020
1 parent dd8e37c commit 58d095c
Show file tree
Hide file tree
Showing 11 changed files with 803 additions and 100 deletions.
88 changes: 88 additions & 0 deletions Artificial/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<!-- ![Repository Banner](headerimage.png) -->
#### Please read [`contributing guidelines`](./contributing.md) before submitting new resources.

## Table of Contents

- [UI Graphics](#ui-graphics)
- [Fonts](#fonts)

## UI Graphics

>Websites and resources with modern UI components in different formats such as PSD, Sketch, Figma, etc. They are great for ideas for web components/UI
| Website&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | Description |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [UI Design Daily](https://uidesigndaily.com/) | Awesome UI Components of all types |
| [100 Daily UI](https://100dailyui.webflow.io/) | Free Figma library of products, elements, and screens |
| [Sketch App Sources](https://www.sketchappsources.com/) | Sketch UIs, wireframes, icons and much more |
| [Humaaans](https://www.humaaans.com/) | Cool illustrations of people with the ability to mix and match |
| [Paaatterns](https://products.ls.graphics/paaatterns/) | Free collection of beautiful patterns for all vector formats |
| [thepatternlibrary](http:https://thepatternlibrary.com/) | Free beautiful background patterns |
| [404 illustration](https://error404.fun/) | free illustrations for 404 pages |
| [Drawkit.io](https://www.drawkit.io/) | Illustrations for designers and startups |
| [Undraw.co](https://undraw.co/) | Open-source illustrations for any idea you can imagine and create |
| [Manypixels.co](https://www.manypixels.co/gallery/) | Monochromatic, Isometric high quality illustrations |
| [Open Peeps](https://www.openpeeps.com/) | Hand drawn illustration library |
| [UI Space](https://uispace.net/) | Thousands of great UI freebies |
| [Animations.co](http:https://animaticons.co/) | Beautiful, customizable animated GIF icons |
| [Uplabs](https://www.uplabs.com/) | High-quality design resources (Free & Premium) |
| [InvisionApp](https://www.invisionapp.com/inside-design/design-resources/) | Library of free, high-quality UI kits, icon packs, and mockups |
| [Open Doodles](https://www.opendoodles.com/) | A Free Set of Sketchy Illustrations |
| [Avataaars](https://avataaars.com/) | Free sketch library of avatars illustrations by Pablo Stanley |
| [FreebieSketch](http:https://freebiesketch.com/) | Free Sketch designs, wireframes, illustrations, and more. |
| [Blush](https://blush.design/) | Free customizable illustrations with Figma Plugin |
| [Hero Patterns](http:https://www.heropatterns.com/) | A collection of repeatable SVG background patterns |
| [IsoFlat](https://isoflat.com/) | A Free collection of Isometric SVG graphic resources |
| [Hero Patterns](http:https://www.heropatterns.com/) | A collection of repeatable SVG background patterns |
| [IRA Design](https://iradesign.io/) | An open-source gradient illustrations collection by creative tim. |
| [Storytale.io](https://storytale.io/freebies/) | Subset of Storytale free quality illustrations |
| [icons8.com/illustrations](https://icons8.com/illustrations) | Free vector illustrations to class up your project |
| [Patternico](https://patternico.com) | Seamless Pattern Maker |
| [Freellustrations](https://freellustrations.com/) | Free Background Images for awesome landing Pages |
| [Pixeltrue Illustrations](https://www.pixeltrue.com/illustrations) | Free Animated Illustrations |
| [Abstract User Avatar API](https://www.abstractapi.com/user-avatar-api) | API to create simple yet flexible user avatars from user names or emails |
| [sketchvalley](https://sketchvalley.com/) | Downlode free PNG, SVG or AI file . |

<div align="right">
<b><a href="#table-of-contents">↥ Back To Top</a></b>
</div>

## Fonts

>Websites that offer free fonts as well as font based tools
| Website&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | Description |
| ----------------------- | ------------------ |
| [Google Fonts](https://fonts.google.com/)| Library of around 1000 free licensed font families |
| [DaFont](https://www.dafont.com/)| Archive of freely downloadable fonts |
| [Use & Modify](https://usemodify.com/)| Personal selection of beautiful, classy, punk, professional, incomplete, weird typefaces |
| [1001 Free Fonts](https://www.1001freefonts.com/)| I think the name speaks for itself :smirk: |
| [Font Squirrel](https://www.fontsquirrel.com/)| Font Squirrel scours the internet for high quality, legitimately free fonts |
| [Font Fabric](https://www.fontfabric.com/free-fonts/)| A digital type foundry crafting retail fonts and custom typography for various brands |
| [Tiff](https://tiff.herokuapp.com/)| A type diff tool that visually contrasts the differences between two fonts |
| [TypeKit Practice](https://practice.typekit.com/)| Learn about typography practices |
| [Fontjoy](https://fontjoy.com/)| Generate font pairing in one click |
| [Golden Ratio](https://grtcalculator.com/)| Golden Ratio Typography Calculator |
| [FontSpark](https://fontspark.app/) | Discover Better Fonts |
| [FontPair](https://fontpair.co/) | Helps you pair Google Fonts together
| [Font Space](https://www.fontspace.com/)| A designer-centered free font website that has quick customizable previews |
| [Abstract Fonts](http:https://www.abstractfonts.com/)| Fonts free for personal and commercial use |
| [Free Typography](https://freetypography.com/)| A list of high quality fonts |
| [Leon Sans](https://github.com/cmiscm/leonsans/)| A geometric sans-serif typeface made with code |
| [Lexend](https://www.lexend.com/)| A variable font empirically shown to significantly improve reading-proficiency |
| [Fonts for Apple Platforms](https://developer.apple.com/fonts/)| Get the details, frameworks, and tools you need to use system fonts for Apple platforms in your apps |
| [SFWin](https://github.com/blaisck/sfwin/)| San Francisco Fonts for Windows 10 and non-Apple Platform |
| [Font Flipper](https://fontflipper.com/)| Preview 800+ Google Fonts on top of your own designs, without having to download the fonts |
| [Fonts Arena](https://fontsarena.com/) | Free curated fonts |
| [Befonts](https://befonts.com/) | High quality fonts for free |
| [Arabic fonts](https://arabicfonts.net/) | Arabic fonts for free |
| [FontDrop](https://fontdrop.info) | Simple and easy way to view the contents of font files |
| [Open Foundry](https://open-foundry.com) | FREE platform for curated open-source typefaces |
| [Glyphter](https://glyphter.com) | Upload your own SVGS and turn them into font files. Usefull if you want a smaller library loaded |
| [Google Webfonts Helper](https://google-webfonts-helper.herokuapp.com/fonts) | A Hassle-Free Way to Self-Host Google Fonts |
| [Rough Font Awesome](https://djamshed.github.io/rough-awesome-font/dist/)| When RoughJS meets Font Awesome |

<div align="right">
<b><a href="#table-of-contents">↥ Back To Top</a></b>
</div>

97 changes: 4 additions & 93 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to the contributions of OPTIM
# Welcome to the contributions of CS_COURSE_GUIDE

We follow a systematic Git Workflow -

Expand All @@ -8,101 +8,12 @@ We follow a systematic Git Workflow -
- **Every change** that you do, it has to be on a branch. Commits on master would directly be closed.
- Make sure that before you create a new branch for new changes,[syncing with upstream](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) is neccesary.

## Setup and running of project (Backend)

- Fork the repo and clone it.
- If you had a previous version of the project, please delete the old env folder and create a new one
- The project now uses node.js , you should have a node version greater than 12.0.0 to run the project
## Steps to write the readme file .

- You should have pre-commit installed , do it using the command<br> `curl https://pre-commit.com/install-local.py | python -`
- Focus on the issue you are trying to solve
- Go through the sample readme given in the other folders to understand way the reame markup is written you can also learn about writing the readme markup here

- Run these commands

```bash
pre-commit install
```

- This will setup the project requirements and pre-commit test hooks!

- Setup a test databse on mongodb Atlas
- Create a user , establish the network connection on mongo db atlas
- Create a new cluster.

- change the current directory and navigate into the server folder using the command <br> `cd server`
- Copy the connection url of the databse and paste it in the ./server/.env file and doker-compose.yml file .

- To install all the dependencies run 'npm i'

- Setup the .env file using the instruction in the section below

- After the above setup, run <br>
`nodemon .` or
`node .`

- This will start the backend dev server
Runs the backend server at default port `5000`.<br />
Open [http:https://localhost:5000](http:https://localhost:5000) to view it in the browser.

- To exit the poetry virtual environment run `exit`.

## Setting up the ./server/.env file

- create a .env file in the server directory
-the ENVIRONMENT VARIABLES REQUIRED ARE --<br>
GOOGLE_CLIENTID = ' ' <br>
GOOGLE_CLIENTSECRET <br>
MONGO_URI <br>
COOKIEKEY = 'any random value' <br>
JWTTOKEN = 'any random value<br>
GITHUB_CLIENTID = ' setup a github o-auth application and copy this ' <br>
GITHUB_CLIENT_SECRET = ' setup a github o-auth application and copy this '<br>
UPLOAD_DP = ' folder id of a drive folder '<br>
UPLOAD_POST = ' folder id of a drive folder '<br>

## Setup and running of project (Frontend)

- navigate into the client directory using <br> `cd client`
- At your client directory run `npm install` to install all the dependencies
- Start react dev server
- `npm run start`

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

The page will reload if you make edits.<br />
You will also see any lint errors in the console.

## Running with Docker (Backend)

- Ensure that you have `docker` and `docker-compose` already installed.
- At the root of the project directory run `docker-compose up --build` to build the image for the first time.
- To start the backend run `docker-compose up -d`.
- Ensure that the backend is running by going to [http:https://127.0.0.1:4000](http:https://127.0.0.1:4000).

## Generating a CLIENT ID for Google OAuth Login

- Create a new project with name **OPTIM** in _Google Cloud Platform_.
- Enable **Cloud OS Login API** from the API Library in _Google Cloud Platform_.
- Go to **API & Services** section and click on **Create Credential**.
- Choose _OAuth Client ID_.
- Setup the consent screen if asked to do so.
- Select **Web Application** as the _Application Type_.
- Whitelist `localhost:3000` under _Authorised Javascript Origins_.
- Click on **Create**
- Copy the **ClientID** and paste it in `.env` file alongside **REACT_APP_OAUTH_CLIENT_ID**.

## Using Google Cloud Storage for storing _static_ and _media_ files (Only required for PRODUCTION)

- First, you need a service account for connecting to GCP
- Head over to this [page](https://cloud.google.com/docs/authentication/getting-started) and click on **Create Service Account**
- Select the relavant project
- From the dropdown for _Service Account_ choose _New-service account_
- Download the `JSON` file and store it at your project root.
- Rename the file to `service-account.json`
- Set `GOOGLE_APPLICATION_CREDENTIALS` to the path to `service-account.json` in above point in the `.env` file.
- Create a bucket on GCP with the relavant name
- Copy the bucket name and in `.env` file set `GS_BUCKET_NAME` to your bucket name.

#### Note

- As the project now uses `npm` to manage dependencies, you need to run `npm install <package_name>` **IN THE SERVER OR CLIENT RESPECTIVELY** to install the new package.
Loading

0 comments on commit 58d095c

Please sign in to comment.