diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..06bf37c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Macktireh Abdi Soubaneh + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 3395eec..a114191 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ # Clone the Twitter Frontend with React TS + +This repository contains the frontend source code of the Twitter clone project. I used React, TypeScript and Redux to build the user interface of the application. + +## Startup + +### Prerequisites + +- Nodejs +- Git + +### Installation + +#### 1. Clone the git repository + +If you have `Git` on your computer, use the commands below, otherwise just download the project. + +```bash +git clone https://github.com/Macktireh/clone-twitter-frontend.git clone-twitter-backend +``` + +```bash +cd clone-twitter-backend +``` + +```bash +npm install +``` + +```bash +npm start +```