Skip to content

Commit 206867b

Browse files
committed
docs: Update README.
1 parent 4875fc7 commit 206867b

1 file changed

Lines changed: 48 additions & 9 deletions

File tree

README.md

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,55 @@
1-
# codephile
1+
# Codephile
22

3-
A new Flutter project.
3+
Codephile is an application specially made for all the competitive coders out there. With features
4+
like submission feed, contest reminders, user search, and many more, this app is a perfect companion
5+
for stalking your fellow coders and learning from them.
6+
7+
## Screenshots
8+
9+
<img src="https://user-images.githubusercontent.com/60056833/111873783-1ab52900-89b8-11eb-8951-ca6c13249c05.png" width="200" height="400" /> <img src="https://user-images.githubusercontent.com/60056833/111873786-1c7eec80-89b8-11eb-9625-d19a05b15e25.png" width="200" height="400" /> <img src="https://user-images.githubusercontent.com/60056833/111873792-1f79dd00-89b8-11eb-9030-e26c91621304.png" width="200" height="400" /> <img src="https://user-images.githubusercontent.com/60056833/111873795-2143a080-89b8-11eb-9a28-04ea3f216b5b.png" width="200" height="400" />
10+
<img src="https://user-images.githubusercontent.com/60056833/111873771-0ffa9400-89b8-11eb-8be2-2ac328356207.png" width="200" height="400" /> <img src="https://user-images.githubusercontent.com/60056833/111873773-12f58480-89b8-11eb-8d95-7f905b6d8fa5.png" width="200" height="400" /> <img src="https://user-images.githubusercontent.com/60056833/111873778-15f07500-89b8-11eb-8b46-79abab630f0d.png" width="200" height="400" /> <img src="https://user-images.githubusercontent.com/60056833/111873781-1852cf00-89b8-11eb-807e-05bf63a82d9b.png" width="200" height="400" />
411

512
## Getting Started
613

7-
This project is a starting point for a Flutter application.
14+
Project structure:-
15+
16+
```
17+
|-lib
18+
| |-models {contains object models | used for communication with the back-end}
19+
| |-screens {contains code for the UI}
20+
| |-services {contains code for the buisness logic}
21+
| |-resources {common resources like assets addresses}
22+
| |-main.dart {entry point}
23+
|-assets {contains icons, logos...}
24+
|-android
25+
|-ios
26+
|-test
27+
```
28+
29+
## How to Contribute
30+
31+
We'd love to accept your patches and contributions to this project. There are just a few small
32+
guidelines you need to follow.
33+
34+
- When contributing to this repository, please first discuss the change you wish to make via the
35+
issues section before starting any major work.
36+
- Once you have started work on any issue open a WIP pull request addressing that issue so that we
37+
know that someone is working on it.
38+
- While writing any code for this project ensure that it is well formatted and consistent with the
39+
architecture of the rest of the project.
40+
- Please make sure that you use the
41+
standard [dart nomenclature](https://dart.dev/guides/language/effective-dart/style).
42+
- Before committing any change make sure their is no compilation warning or error.
843

9-
A few resources to get you started if this is your first Flutter project:
44+
### For commit messages
1045

11-
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
46+
Please start your commits with these prefixes for better understanding among collaborators, based on
47+
the type of commit:
1348

14-
For help getting started with Flutter, view our
15-
[online documentation](https://flutter.dev/docs), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
49+
feat: (addition of a new feature)
50+
rfac: (refactoring the code: optimization/ different logic of existing code - output doesn't change, just the way of execution changes)
51+
docs: (documenting the code, be it readme, or extra comments)
52+
bfix: (bug fixing)
53+
chor: (chore - beautifying code, indents, spaces, camelcasing, changing variable names to have an appropriate meaning)
54+
ptch: (patches - small changes in code, mainly UI, for example color of a button, incrasing size of tet, etc etc)
55+
conf: (configurational settings - changing directory structure, updating gitignore, add libraries, changing manifest etc)

0 commit comments

Comments
 (0)