Kieran/snort
5
14
Fork 14
Code Issues 37 Pull Requests 1 Packages Projects Releases 24 Wiki Activity

Change README.md file

Browse Source
This commit is contained in:
jainex17 2023-01-03 20:06:41 +05:30
parent bc082ec203
commit c3197c09cc
1 changed files with 22 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -1,70 +1,36 @@
# Getting Started with Create React App
# Nostr - Social Media Website
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Welcome to Nostr, a social media platform built with ReactJS! Nostr allows users to create profiles, post text and photos, follow other users, and engage with each other through likes, comments, and shares.
## Available Scripts
## Features
In the project directory, you can run:
- Create a user profile with a display name, profile photo, and bio
- Post text and photos to your profile and feed
- Follow other users to see their posts in your feed
- Like, comment, and share posts from other users
- Edit your profile at any time
### `yarn start`
## Tech Stack
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
Nostr is built using the following technologies:
The page will reload when you make changes.\
You may also see any lint errors in the console.
- ReactJS
- [Other relevant technologies, such as a backend language (e.g. Node.js), a database (e.g. MongoDB), etc.]
### `yarn test`
## Getting Started
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
To get started with the Nostr codebase, follow these steps:
### `yarn build`
1. Clone the repository: `git clone https://github.com/[your_username]/nostr.git`
2. Install dependencies: `npm install`
3. Start the development server: `npm start`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
## Contributing
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
If you would like to contribute to the Nostr codebase, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to submit pull requests.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## License
### `yarn eject`
Nostr is licensed under the [Insert License]. Please see the [LICENSE](LICENSE) file for more information.
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `yarn build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
Thank you for checking out Nostr!