Skip to content

Commit c3523ea

Browse files
OmarRamounOmarRamoun
committed
Initial commit
0 parents  commit c3523ea

File tree

5 files changed

+174
-0
lines changed

5 files changed

+174
-0
lines changed

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Ramoun
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
[![](https://img.shields.io/static/v1?label=BY&message=RAMOUN&color=birghtgreen)](https://mrramoun.github.io)
2+
3+
# Project Name
4+
5+
> One paragraph statement about the project.
6+
7+
![screenshot](images/app_screenshot.png)
8+
9+
| *Additional description about the project and its features.*
10+
11+
## Built With
12+
13+
- Languages: _**N/A**_
14+
- Frameworks: _**N/A**_
15+
- Technologies used: _**N/A**_
16+
17+
## Live Demo
18+
19+
[Live Demo Link](https://livedemo.com)
20+
21+
## Getting Started
22+
23+
**This is an example of how you may give instructions on setting up your project locally.**
24+
**Modify this file to match your project, remove sections that don't apply. For example: delete the testing section if the currect project doesn't require testing.**
25+
26+
To get a local copy up and running follow these simple example steps.
27+
28+
### Prerequisites
29+
30+
- [**npm**](https://nodejs.org) (**n**ode **p**ackage **m**anager) - to be able to install packages locally.
31+
- **A github Account** - to be able to use github actions.
32+
33+
### Setup
34+
35+
- **Open** the terminal.
36+
- **Run** `cd \path\to\where\you\want\your\local\copy`
37+
- **Clone** the repo
38+
1. **Run** `git clone git@github.com:MrRamoun/README.git`
39+
2. **Run** `cd README/`
40+
41+
### Install
42+
43+
- install **Webhint** linter
44+
45+
1. **Run** `npm install --save-dev hint@6.x`
46+
2. **Copy** [.hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css/.hintrc) file to the root directory of your project.
47+
48+
- install **Stylelint** linter
49+
50+
1. **Run** `npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x`
51+
2. **Copy** [.stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css/.stylelintrc.json) to the root directory of your project.
52+
53+
54+
### Usage
55+
56+
### Run tests
57+
58+
- run **Webhint** linter
59+
- **Run** `npx hint .` on the root of your directory of your project.
60+
- run **Stylelint** linter
61+
- **Run** `npx stylelint "**/*.{css,scss}"` on the root of your directory of your project.
62+
63+
### Deployment
64+
65+
## Authors
66+
67+
👤 **Author1**
68+
69+
- **GitHub**: [![@mrramoun](https://img.shields.io/github/followers/MrRamoun?label=Ramoun&style=social)](https://github.com/mrramoun)
70+
- **Twitter**: [![@ramoun16](https://img.shields.io/twitter/follow/ramoun16?label=ramoun16&style=social)](https://twitter.com/ramoun16)
71+
- **LinkdIn**: [![@ramoun](https://img.shields.io/github/followers/ramon?label=ramoun&logo=linkedin&style=social)](https://www.linkedin.com/in/ramoun/)
72+
73+
👤 **Author2**
74+
75+
- GitHub: [@githubhandle](https://github.com/githubhandle)
76+
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
77+
- LinkedIn: [LinkedIn](https://linkedin.com/linkedinhandle)
78+
79+
## 🤝 Contributing
80+
81+
Contributions, issues, and feature requests are welcome!
82+
83+
Feel free to check the [issues page](issues/).
84+
85+
## Show your support
86+
87+
Give a ⭐️ if you like this project!
88+
89+
## Acknowledgments
90+
91+
- Hat tip to anyone whose code was used
92+
- Inspiration
93+
- etc
94+
95+
## 📝 License
96+
97+
This project is [MIT](lic.url) licensed.

‎images/app_screenshot.png‎

6.2 KB
Loading

‎manifesto/plan.txt‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
** all of this is part of the freestyle department (section 3: totally from scratch)[section 2: guideded][section 1: N/A]
2+
* if it can be done through a third-party, it should be done through a 3rd party
3+
1) 0-phase
4+
1- what is product: webapp, App
5+
2- what do we want to deliver:
6+
"this is a portfolio webapp",
7+
"this is a modern minimal skeumorphic webapp",
8+
"simple to use"
9+
3- what do we stand for: "simplicity"
10+
4- what is new: "the most minimal webapp in the world (currently)"
11+
5- how to make it alive: "through cool animations"
12+
6- (audit): [ ]
13+
2) content
14+
1- important topics: N/A
15+
2- what do we want to deliver through content: N/A
16+
3- use \0-phase\ as refrence and guide: N/A
17+
4- skeetch a structure visual vin shapes(SITEMAP): N/A
18+
5- (audit): N/A
19+
> all content management is defered to later.
20+
3) ui & design
21+
> designes are done through a 3rd-party
22+
1- msg or expressive: msg
23+
2- if msg {feeling/idea}: feeling
24+
3- if expressive {what do u want to express & how to express in a way that serves the idea}: N/A
25+
4- use \0-phase\ && \content\ as guide: N/A
26+
5- see previous tries and judge them according to your pov: N/A
27+
6- start sketching: N/A
28+
7- prepare softwares and tools: N/A
29+
8- start implementation: N/A
30+
9- (audit): [ ]
31+
4) coding
32+
1- user \all-previous\ as guide: [ ]
33+
2- start design on paper (paradigm and so on): [ ]
34+
3- prepare software and tools: [ ]
35+
4- start implementation
36+
5- (audit)
37+
5) testing
38+
1- user :all-previous: as guide
39+
2- start on paper
40+
3- determine the tests needed and how to implement them
41+
4- start implementation
42+
5- (audit)
43+
6) (audit)

‎manifesto/tools.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Paradigm: OOP
2+
Tools:
3+
- lingos: html, css, js
4+
- IDEs: VSCode, CMDER
5+
- browsers: Chrome
6+
- docs: w3schools, html_bp, css_bp, js_bp
7+
- SCMs: git, github
8+
- OS: windows_7
9+
10+
Concepts:
11+
- general: divide_and_conquer
12+
- oop: TOE
13+
- problem_solving: 5s-problem-solving-technique

0 commit comments

Comments
 (0)