https://github.com/androiddevnotes/android-dev-notes-website
🚀 👀 The website of Android Dev Notes. Content contributions are welcome! Found something interesting related to Android, just add it! check out X!
https://github.com/androiddevnotes/android-dev-notes-website
android android-app android-development android-studio blog contributions-welcome jetpack-compose kotlin learn-to-code mvvm retrofit room website
Last synced: 10 months ago
JSON representation
🚀 👀 The website of Android Dev Notes. Content contributions are welcome! Found something interesting related to Android, just add it! check out X!
- Host: GitHub
- URL: https://github.com/androiddevnotes/android-dev-notes-website
- Owner: androiddevnotes
- License: other
- Created: 2023-02-15T00:25:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T12:41:38.000Z (about 1 year ago)
- Last Synced: 2025-03-26T05:09:31.019Z (10 months ago)
- Topics: android, android-app, android-development, android-studio, blog, contributions-welcome, jetpack-compose, kotlin, learn-to-code, mvvm, retrofit, room, website
- Language: JavaScript
- Homepage: https://www.androiddevnotes.com/
- Size: 1.41 MB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Android Dev Notes
Android Dev Notes Website.
Link: https://androiddevnotes.com
Explore the Android development resources and notes. Contribute to it and make it better.
## How can I add content?
As a contributor to website of Android Dev Notes, you can add content related to Android/Kotlin in different sections, including Apps, Libraries, Tools, Tutorials, and Insights. Here are some guidelines to help you add content to the website:
Explore the website and see which section you can add content to. You are free to create new directories or files inside the sections to better organize content.
Take a look at `.mdx` files on GitHub in 'docs' directory. You can use the same format to add content to the website for the sections.
### Apps section
In Apps section, you can add open source apps that you have found useful and think others will find useful too.
Example: Found an okay app with modern architecture and want to share it with others? Add it to the Apps section.
Format: The format for title is flexible. However, usually it is: `App Name - Short intro`. For example, `Palov - A Recipe App in Jetpack Compose`.
### Libraries section
In Libraries section, you can add libraries that you have found useful and think others will find useful too.
Example: Found a new library for image processing and want to share it with others? Add it to the Libraries section.
### Socials section
In Socials section, you can add socials related to android dev notes like X, YouTube!
### Tools section
In Tools section, you can add tools that you have found useful and think others will find useful too.
Example: Found a tool that can boost productivity in Android Studio and want to share it with others? Add it to the Tools section.
### Tutorials section
In Tutorials section, you can add tutorials that you have found useful or write your own tutorials that you think others will find useful too.
Example: Found a tutorial that is simply interesting and want to share it with others? Add it to the Tutorials section.
### Insights section
In Insights section, you can add any other useful information related to Android, such as website links, discussions, tips and tricks, or news about Android releases or deprecations.
Example: Found out something's going to be released soon or getting deprecated about Android and want to share it with others? Add it to the Insights section.
All above examples are just for reference. You can add whatever sane content to any section that you think is useful.
By following these guidelines, you can contribute to the Android community by sharing useful information and resources with others.
Check out the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on how to contribute to the Android Dev Notes website.
## Build Instructions
### Clone the repository
```bash
git clone https://github.com/androiddevnotes/android-dev-notes-website.git
```
### cd into the directory
```bash
cd android-dev-notes-website
```
### Installation
```bash
npm install
```
### Local Development
```bash
npm start
```
This particular command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Website is running at http://localhost:3000/
Before contributing, you can optionally run the website locally to see if your changes look good and then create a pull request.
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.